接口功能介绍
查看 IPv6 带宽列表。
接口约束
无。
URI
GET /v4/ipv6_bandwidth/list
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 资源池 ID | 81f7728662dd11ec810800155d307d5b |
| queryContent | String | 否 | 【模糊查询】 IPv6 带宽实例名称。 | test |
| bandwidthID | String | 否 | IPv6 带宽 ID | bandwidth-sjwu65pf9t |
| pageNumber | Integer | 否 | 列表的页码，默认值为 1。 | 1 |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
| pageSize | Integer | 否 | 分页查询时每页的行数，最大值为 50，默认值为 10。 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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 | 返回查询的共享带宽实例的详细信息。 | 见下表 |
| totalCount | Integer | 总数 | 1 |
| currentCount | Integer | 分页查询时每页的行数 | 1 |
| totalPage | Integer | 分页查询时总页数 | 1 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| id | String | IPv6 带宽 ID | bandwidth-sjwu65pf9t |
| status | String | IPv6 带宽状态: ACTIVE（正常） / EXPIRED（过期） / FREEZING（冻结） /CREATEING（创建中） | CREATEING |
| name | String | IPv6 带宽名字 | xxxx |
| bandwidth | Integer | IPv6 带宽峰值 mbps | 1 |
| resourceSpec | String | 独享 / 共享 | standalone |
| paymentType | String | 计费类型 | 包年包月 |
| createdTime | String | IPv6 带宽创建时间 | 2022-10-11T19:50:44Z |
| expiredTime | String | IPv6 带宽过期时间 | 2022-11-11T19:50:44Z |
| ipAddress | String | IP 地址 | :: |
| ipv6GatewayID | String | IPv6 网关 ID | xxxx |
请求示例
GET /v4/ipv6_bandwidth/new-list?regionID=81f7728662dd11ec810800155d307d5b
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [{
"id": "bandwidth-sjwu65pf9t",
"status": "CREATING",
"expired": false,
"name": "xxxx",
"ipAddress": "::",
"ipv6GatewayID": null,
"bandwidth": 1,
"payment_type": "包年包月",
"created_time": "2022-10-11T19:50:44Z",
"expired_time": "2022-10-11T19:50:44Z",
"resourceSpec": "standalone",
}],
"totalCount": 1,
"currentCount": 1,
"totalPage": 1
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
