接口功能介绍
调用此接口可查询指定区域下共享带宽实例列表。
接口约束
无。
URI
GET /v4/bandwidth/list
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 共享带宽所在的区域id。 | 81f7728662dd11ec810800155d307d5b |
| queryContent | String | 否 | 【模糊查询】 共享带宽实例名称。 | |
| projectID | String | 否 | 企业项目 ID，默认为"0" | 0 |
| 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 |
| totalCount | Integer | 列表条目数。 | 20 |
| currentCount | Integer | 分页查询时每页的行数。 | 4 |
| totalPage | Integer | 分页查询时总页数。 | 5 |
| returnObj | Array of Objects | object | 返回查询的共享带宽实例的详细信息。 |
表 returnObj
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| id | String | 共享带宽id。 | bandwidth-sjwu65pf9t |
| status | String | 共享带宽状态: ACTIVE / EXPIRED / FREEZING | ACTIVE |
| bandwidth | int | 共享带宽的带宽峰值， 单位：Mbps。 | 5 |
| name | String | 共享带宽名称。 | share_ip_069f |
| eips | Array of Objects | 绑定的弹性 IP 列表 ｜ 见下表 |
表 eips
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| ip | String | 弹性 IP 的 IP | 100.124.10.1 |
| eipID | String | 弹性 IP 的 ID | eip-ieeq36299f |
请求示例
GET /v4/bandwidth/new-list?regionID=xxx
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"id": "bandwidth-sjwu65pf9t",
"status": "ACTIVE",
"bandwidth": 5,
"name": "share_ip_069f",
"eips": []
},
{
"id": "bandwidth-jfx75s4dga",
"status": "ACTIVE",
"bandwidth": 5,
"name": "share_ip_b290",
"eips": []
},
{
"id": "bandwidth-taayvohh94",
"status": "ACTIVE",
"bandwidth": 5,
"name": "share_ip_dd21",
"eips": []
},
{
"id": "bandwidth-fd4yt9ci58",
"status": "ACTIVE",
"bandwidth": 5,
"name": "share_ip_2200",
"eips": []
},
{
"id": "bandwidth-ulvku3pots",
"status": "ACTIVE",
"bandwidth": 5,
"name": "share_ip_f07e",
"eips": []
}
],
"currentCount": 5,
"totalCount": 5,
"totalPage": 1
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
