跳转到主要内容
API Explorer|API Explorer
资源中心/网络服务/网络服务相关接口/虚拟IP相关接口
GETVIP Operations起始版本 0.6同步需要认证

查询虚拟IP

查询虚拟IP

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

此接口无需请求参数。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • l3NetworkUuidString必填

      三层网络UUID

    • ipString必填

      IPv4类型的IP地址

    • stateString必填

      状态（启用，禁用）

    • gatewayString必填

      网关

    • netmaskString必填

      子网掩码

    • prefixLenString必填

      掩码长度

    • serviceProviderString必填

      提供VIP服务的服务提供者

    • peerL3NetworkUuidString必填

      L3网络UUID

    • useForString必填

      用途，例如：端口转发

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

GET/zstack/v1/vips

/zstack/v1/vips

操作 ID

QueryVip

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/vips' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "uuid": "8c5eb4938be549218fda4c87de4d8cad", "name": "new name", "ipRangeUuid": "7d0dda5b1c4f40069ec4cfd6b66bdf48", "l3NetworkUuid": "a81054a6807e47a09922473e9ab376cb", "ip": "192.168.0.1", "state": "Enabled", "gateway": "127.0.0.1", "netmask": "255.255.0.0", "peerL3NetworkUuid": [ "64ef7a2ea9ec4095b343ea239a7ba344" ] } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史