获取高可用虚拟IP列表
更新时间：2022-11-10
接口描述
本接口用来查询高可用虚拟IP（HAVIP）列表信息。
请求结构
JSON
1GET /v1/vpc/havip{?keyword,keywordType,order,orderBy,pageNo,pageSize,subnetId,vpcId} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | 否 | Query参数 | 页号，缺省值为1 |
| pageSize | Integer | 否 | Query参数 | 查询返回每页个数，取值范围为1～100，缺省值为100 |
| keywordType | String | 否 | Query参数 | 查询的关键字类型，取值为HAVIP_ID、 HAVIP_NAME、INTERNAL_IP，分别表示高可用虚拟IP的ID、名称和IP地址 |
| keyword | String | 否 | Query参数 | 查询的关键字值 |
| vpcId | String | 否 | Query参数 | 私有网络ID。用于查询所属VPC的资源 |
| subnetId | String | 否 | Query参数 | 子网ID。用于查询所属子网的资源 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | List<HaVipVo> | HAVIP列表数据 |
| orderBy | String | 排序字段，缺省为createTime |
| order | String | 排序顺序,取值为DESC、ASC，分别表示为降序、升序。缺省为DESC |
| pageNo | Integer | 页码 |
| pageSize | Integer | 每页结果数 |
| totalCount | Integer | 结果总数 |
请求示例
JSON
1GET /v1/vpc/havip HTTP/1.1
2Host: bec.baidubce.com
3ContentType: application/json
4Authorization: authorization string 返回示例
JSON
1 HTTP/1.1 200 OK
2 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Thu, 16 Mar 2021 06:29:48 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS
6
7 {
8 "result": [
9 {
10 "name": "myhavip",
11 "haVipId": "havip-mldpfkonbqoq",
12 "regionId": "cn-hangzhou-cm",
13 "vpcId": "vpc-1fd9vkmlo7mh",
14 "subnetId": "sbn-wezri2k5rptt",
15 "privateIpAddress": "192.168.0.51",
16 "status": "available",
17 "createTime": "2022-08-22T13:20:32Z",
18 "associateNum": 0
19 }
20 ],
21 "orders": null,
22 "orderBy": "createTime",
23 "order": "desc",
24 "pageNo": 1,
25 "pageSize": 1000,
26 "totalCount": 1
27 }错误码
请参照错误返回章节的内容。
Model对象定义
HaVipVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| haVipId | String | HAVIP ID |
| name | String | HAVIP名称 |
| vpcId | String | 所属VPC ID |
| subnetId | String | 所属子网 ID |
| regionId | String | 节点ID |
| privateIpAddress | String | 内网IP地址 |
| status | String | 状态： available 可用；binded 已绑定 |
| associateNum | Integer | 已绑定实例数量 |
| createTime | String | 创建时间（UTC） |