接口功能介绍
调用此接口可查询 IPv6 列表。
接口约束
无。
URI
GET /v4/ipv6/ipv6-list
请求参数
Query 参数
| 参数 | 参数类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 资源池ID | |
| vpcID | sting | 否 | vpc id | |
| subnetID | String | 否 | 子网id | |
| ipAddress | String | 否 | ipv6地址 | |
| page | Integer | 否 | 分页参数 | 1 |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, page 后续会废弃 | 1 |
| pageSize | Integer | 否 | 每页数据量大小，取值1-50 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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 | Object | 业务数据 | 见下表 |
| totalCount | Integer | 列表条目数 | 20 |
| currentCount | Integer | 分页查询时每页的行数。 | 4 |
| totalPage | Integer | 总页数 | 5 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| ipv6s | Array of Objects | IPv6 列表 | 见下表 |
表 ipv6s
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| ID | String | ipv6 id | |
| vpcID | sting | vpc id | |
| subnetID | String | 子网id | |
| ipAddress | String | ipv6地址 | |
| associationID | String | 绑定实例的id | |
| associationType | int | 绑定实例类型 0: port, 1:ha_vip, 2:elb | |
| bandwidthID | int | 公网带宽id | |
| createdAt | time | 创建时间 | |
| updatedAt | time | 更新时间 |
请求示例
GET /v4/ipv6/ipv6-list?regionID=xxxx
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"ipv6s": [
{
"ID": "ipv6-zkuai8d2vv",
"vpcID": "vpc-5xyj41ft5b",
"ipAddress": "100:0:9:0:3d:724f:1:a937",
"associationID": "port-9kryefoc48",
"associationType": 0,
"subnetID": "subnet-qiu06n0k7y",
"bandwithID": "",
"createdAt": "2022-03-23T02:42:09Z",
"updatedAt": "2022-03-23T02:42:09Z"
}
],
"currentCount": 1,
"totalCount": 20,
"totalPage": 20
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
