查询高可用虚拟IP列表
所有文档
menu

私有网络 VPC

查询高可用虚拟IP列表

产品详情自助选购


描述

查询高可用虚拟IP列表。

请求结构

GET /v{version}/havip?vpcId={vpcId}&marker={marker}&maxKeys={maxKeys} HTTP/1.1   
Host: bcc.bj.baidubce.com      
Authorization: authorization string

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值为1
vpcId String Query参数 高可用虚拟IP所属的VPC ID
marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串
maxKeys Integer Query参数 每页包含的最大数量,最大数量不超过1000,缺省值为1000

返回头域

除公共头域,无其它特殊头域。

返回参数

参数名称 类型 描述
haVips List<HaVip> 高可用虚拟IP列表
marker String 标记查询的起始位置,若结果列表为空,此项不存在
isTruncated Boolean true表示后面还有数据,false表示已经是最后一页
nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
maxKeys Integer 每页包含的最大数量

请求示例

GET /v1/havip?vpcId=vpc-r625rqw3wuer&maxKeys=1 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 7e789a40-adac-414a-8bd4-916d6be61112
Date: Mon, 02 Apr 2019 08:14:25 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
    "haVips":[
        {
            "haVipId":"havip-jshdu47sk",
            "name":"test_havip",
            "description":"",
            "vpcId":"vpc-r625rqw3wuer",
            "subnetId":"sbn-i4d47zb73ztx",
            "status":"available",
            "privateIpAddress":"192.168.1.221",
            "publicIpAddress":"180.76.245.166",
            "createdTime":"2022-08-31T11:42:19Z"
        }
    ],
   "marker": "havip-w2d4kgc3x0y1",
   "isTruncated": true,
   "nextMarker": "havip-wcd4jgc3x0y1",
   "maxKeys": 1
}
上一篇
创建高可用虚拟IP
下一篇
查询指定的高可用虚拟IP