接口功能介绍
查询虚拟IP列表。
接口约束
无
URI
POST /v4/vpc/havip/list
请求参数
请求体Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| regionID | String | 是 | 资源池ID | |
| projectID | String | 否 | 企业项目ID，默认为"0" | |
| filters | Object of Array | 否 | 筛选条件 |
表 filters
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| key | String | 是 | 筛选字段的key，支持：haVipID，vpcID，subnetID | |
| value | String | 是 | 筛选字段对应key的value |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Array of Objects | 接口业务数据 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| id | String | 高可用虚IP的ID | havip-xxxx |
| ipv4 | String | IPv4地址 | 192.168.1.1 |
| vpcID | String | 虚拟私有云的的id | vpc-xxxx |
| subnetID | String | 子网id | subnet-xxx |
| instanceInfo | Array of Objects | 绑定实例相关信息 | 见下表 |
| networkInfo | Array of Objects | 绑定弹性 IP 相关信息 | 见下表 |
表 networkInfo
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| eipID | String | 弹性 IP ID | eip-xxxxxxx |
表 instanceInfo
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| instanceName | String | 实例名 | turn-test7 |
| id | String | 实例 ID | 65c78246-1449-73d4-d43c-2af0f395f519 |
| privateIp | String | 实例私有 IP | 192.168.50.5 |
| privateIpv6 | String | 实例的 IPv6 地址, 可以为空字符串 | '' |
| publicIp | String | 实例公网 IP | null |
请求示例
请求体body
{
"clientToken": "xxxxxxxxx" ,
"regionID": "100054c0416811e9a6690242ac110002",
"projectID": "project-id",
"filters": [{
"key": "vipID",
"value": "xxxxx"
},{
"key": "vpcID",
"value": "xxxxxxx"
}]
}
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": [{
"id": "havip-id",
"ipv4": "198.172.1.2",
"vpcID": "vpc-xxx",
"subnetID": "subnet-xxx",
"instanceInfo": []
},{
"id": "havip-id",
"ipv4": "198.172.1.2",
"vpcID": "vpc-xxx",
"subnetID": "subnet-xxx",
"instanceInfo": []
}]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
