Bind instance to high-availability virtual IP address
Updated at:2025-10-16
Description
Link the high-availability virtual IP address to a specified instance (such as a cloud server or elastic network interface).
- Instances include cloud server (BCC/BBC/DCC) and elastic network interfaces;
- Up to 5 instances can be bound to each high-availability virtual IP address;
- High-availability virtual IP address features VPC attributes and can only be bound to cloud server or elastic network interface under the same VPC
Request structure
Plain Text
1PUT /v{version}/havip/{haVipId}?{action}&clientToken={clientToken} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4{
5 "instanceIds":{instanceIds},
6 "instanceType":{instanceType}
7}
Request 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 |
| haVipId | String | Yes | URL parameter | High-availability virtual IP address ID |
| action | String | Yes | Query | The value for this API is attach |
| instanceIds | List<String> | Yes | RequestBody | List of bound instance IDs, with a maximum count of 5 |
| instanceType | String | Yes | RequestBody | Type of bound instance, with "SERVER" indicating cloud server (BCC/BBC/DCC), and "ENI" indicating elastic network interface |
| clientToken | String | No | Query | Idempotence Token, which is an ASCII string with a length not exceeding 64 bits. For details, refer to [ClientToken Idempotence Support](VPC/API Reference/General Description.md#Idempotence). |
Response headers
No special headers are required beyond the standard ones.
Response parameters
No special response parameters are available.
Request example
Plain Text
1PUT /v1/havip/havip-w2d4kgc3x0y1?attach&clientToken=cecad37a-5a1e-4135-a1bc-b1a105d12dec HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "instanceIds": ["i-syGfPUYO"],
6 "instanceType": "SERVER"
7}
Response 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
