接口功能介绍
调用此接口可查询 IPv6 网关列表。
接口约束
无。
URI
GET /v4/vpc/list-ipv6-gateway
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| pageNumber | Integer | 否 | 列表的页码，默认值为 1。 | 1 |
| projectID | String | 否 | 企业项目 ID，默认为"0" | 0 |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
| pageSize | Integer | 否 | 分页查询时每页的行数，最大值为 50，默认值为 10。 | 5 |
| regionID | String | 是 | 资源池ID | xj8g-894g-09oi-po09-12ol-6e6a |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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 of Array | object | 返回结果 |
| totalCount | Integer | 列表条目数 | 20 |
| currentCount | Integer | 分页查询时每页的行数。 | 4 |
| totalPage | Integer | 总页数 | 5 |
表 returnObj
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| name | String | 800 | ipv6网关名称 |
| status | String | ACTIVE | 状态：ACTIVE-正常 |
| projectIdEcs | String | 0 | 企业项目 |
| vpcID | String | vpc-a448sdfddf | vpcID值 |
| vpcCidr | String | 192.168.0.0/16 | 无类别域间路由 |
| vpcName | String | xxxxx | vpc名称 |
| ipv6GatewayID | String | igw6-709ccrywnd | ipv6网关惟一值 |
| creationTime | String | 2022-03-03T07:08:19Z | 创建时间 |
请求示例
GET /v4/vpc/list-ipv6-gateway?regionID=81f7728662dd11ec810800155d307d5b&pageSize=2
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"name": "igw6-for-vpc-eqajjtd7g0",
"status": "ACTIVE",
"projectIdEcs": "0",
"vpcID": "vpc-eqajjtd7g0",
"vpcCidr": "192.168.0.0/16",
"vpcName": "tanjin-1",
"ipv6GatewayID": "igw6-fw2zxq7ug4",
"creationTime": "2022-10-25T03:44:15Z"
}
],
"currentCount": 1,
"totalCount": 2,
"totalPage": 2
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考错误码说明。
