Query high-availability virtual IP address list
Updated at：2025-10-16
Description
Fetch the list of high-availability virtual IP addresses.
Request structure
Plain Text
1GET /v{version}/havip?vpcId={vpcId}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization stringRequest headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | For API version No., the current value is 1 |
| vpcId | String | No | Query | VPC ID to which the high-availability virtual IP address belongs |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | Integer | No | Query | Maximum number of items included per page, maximum: 1,000, default: 1,000 |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| haVips | List<[HaVip](VPC/API Reference/Appendix.md#HaVip)> | List of high-availability virtual IP addresses |
| marker | String | Marker indicating the starting position of the query. If the result list is empty, this field does not exist. |
| isTruncated | Boolean | true indicates there is more data later, false indicates it is the last page |
| nextMarker | String | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
| maxKeys | Integer | Maximum number of items included per page |
Request example
Plain Text
1GET /v1/havip?vpcId=vpc-r625rqw3wuer&maxKeys=1 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7e789a40-adac-414a-8bd4-916d6be61112
3Date: Mon, 02 Apr 2019 08:14:25 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "haVips":[
8 {
9 "haVipId":"havip-jshdu47sk",
10 "name":"test_havip",
11 "description":"",
12 "vpcId":"vpc-r625rqw3wuer",
13 "subnetId":"sbn-i4d47zb73ztx",
14 "status":"available",
15 "privateIpAddress":"192.168.1.221",
16 "publicIpAddress":"180.76.245.166",
17 "createdTime":"2022-08-31T11:42:19Z"
18 }
19 ],
20 "marker": "havip-w2d4kgc3x0y1",
21 "isTruncated": true,
22 "nextMarker": "havip-wcd4jgc3x0y1",
23 "maxKeys": 1
24}