创建高可用虚拟IP
更新时间:2025-01-07
接口描述
本接口用来创建高可用虚拟IP(HAVIP)。
请求结构
JSON
1POST /v1/vpc/havip/batch/create{?clientToken} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string
4
5{
6 "deployInstances": [
7 {
8 "ipAddressCount": 1,
9 "ipAddress": "",
10 "regionId": "",
11 "subnetId": "",
12 "vpcId": ""
13 }
14 ],
15 "name": ""
16}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
name | String | 是 | Request Body参数 | 高可用虚拟IP名称,长度不超过65个字符,可由数字、字符、下划线组成 |
deployInstances | List<DeploymentInstance> | 是 | Request Body参数 | 指定的节点请求信息 |
clientToken | String | 否 | Query参数 | 幂等性Token,是一个长度不超过64位的ASCII字符串 |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
result | Boolean | 操作是否成功,true表示成功;false表示失败 |
details | List<HaVipVo> | 返回HAVIP对象列表,包括HAVIP ID |
请求示例
JSON
1 POST /v1/vpc/havip/batch/create{?clientToken} HTTP/1.1
2 Host: bec.baidubce.com
3 Authorization: authorization string
4 {
5 "deployInstances": [
6 {
7 "ipAddressCount": 1,
8 "regionId": "cn-hangzhou-cm",
9 "subnetId": "sbn-zj5fjaf1k",
10 "vpcId": "vpc-xg4faxgl"
11 }
12 ],
13 "name": "haviptest"
14 }
返回示例
JSON
1 HTTP/1.1 200 OK
2 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Thu, 16 Mar 2022 06:29:48 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS
6
7 {
8 "result": true,
9 "details": [
10 {
11 "haVipId": "havip-79mdsrez3z2a",
12 "privateIpAddress": "192.168.0.28",
13 "status": "available"
14 }
15 ]
16}
Modal对象定义
DeploymentInstance
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
regionId | String | 是 | 节点ID,由“国家码-城市-运营商”的小写字母组成字符串。例如 cn-hangzhou-cm,其中国家码标准为ISO 3166-2,城市为拼音,运营商为中国移动cm/中国电信ct/中国联通un/三线ix/bgp |
ipAddressCount | Integer | 是 | 自动分配IP地址数,最小为1。与iPAddress 不能同时存在 |
ipAddress | String | 是 | 指定IPv4地址,与iPAddressCount不能同时存在 |
vpcId | String | 是 | 指定私有网络ID |
subnetId | String | 是 | 指定私有网络的子网ID |
HaVipVo
参数名称 | 类型 | 描述 |
---|---|---|
haVipId | String | 高可用虚拟IP的ID |
privateIpAddress | String | IPv4地址 |
status | String | 状态: available 可用; binded 已绑定实例 |