接口功能介绍
查询带宽列表
接口约束
无
URI
GET /v3/bandwidth/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| name | 否 | String | 带宽名称 | API_Test | |
| pageNum | 否 | Integer | 页码，至少1，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，最大100，默认10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | ||
| list | Array of Objects | 数据列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bandwidthOid | String | 带宽ID | bw-s9561sofpjk7kh52i0038 | |
| name | String | 带宽名称 | bandwidth-aukc8xb | |
| status | String | 状态状态（Creating-创建中;Normal-正常;Deleted-已删除;Changing-变更中;Unhealthy-异常;Frozen-冻结;Deleting-删除中） | Creating | |
| size | Integer | 带宽大小（单位：Mbps） | 1 | |
| vpcOid | String | VPC ID | vpc-xxdwpyq2jgc62h8fjd2e4 | |
| vpcName | String | VPC名称 | vpc-u9ck | |
| elasticIpAddress | String | 弹性IP地址 | ||
| createTime | String | 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-10-20T07:23:52Z | |
| expireTime | String | 到期时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | 2023-11-19T09:31:38Z |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"bandwidthOid":"bw-foo","name":"bandwidth-xxx","status":"Creating","size":1,"vpcOid":"vpc-xxx","vpcName":"vpc-xxx","createTime":"2022-08-24T09:01:58Z","expireTime":"2026-01-11T02:27:53Z"}]}}
状态码
请参考 状态码
错误码
请参考 错误码
