接口功能介绍
创建虚拟IP。
接口约束
无。
URI
POST /v4/vpc/havip/create
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性。要求当个云平台账户内唯一 | xxxxxxxxx |
| regionID | String | 是 | 资源池ID | 100054c0416811e9a6690242ac110002 |
| networkID | String | 否 | VPC的ID | vpc-xxxx |
| subnetID | String | 是 | 子网ID | subnet-xxxx |
| ipAddress | String | 否 | ip地址 | 192.168.3.1 |
| vipType | String | 否 | 虚拟IP的类型，v4-IPv4类型虚IP，v6-IPv6类型虚IP。默认为v4 | v4 |
| description | String | 否 | 描述 | xxxxx |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息，英文 | success |
| descritption | String | statusCode为900时的错误信息，中文 | -- |
| returnObj | Object | 接口业务数据 | 见下表 |
| errCode | String | 错误明细 | SUCCESS |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| uuid | String | 高可用虚IP的ID | havip-id |
| ipv4 | String | 高可用虚IP的地址 | 192.168.3.1 |
请求示例
POST /v4/vpc/havip/create
请求体body
{
"clientToken": "xxxxxxxxx" ,
"regionID": "100054c0416811e9a6690242ac110002",
"azName": "az1",
"projectID": "project-id",
"networkID": "network-id",
"subnetID": "subnet-id",
"ipAddress": "194.168.1.1",
"vipType": "v4",
"description": "Khachi 's HaVip"
}
响应示例
{
"statusCode": 800,
"message": "success",
"description": "",
"errCode": "SUCCESS",
"returnObj": {
"uuid": "havip-id",
"ipv4": "192.168.3.1"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
