查询带宽列表v3
更新时间 2026-07-07 14:17:29
最近更新时间: 2026-07-07 14:17:29
接口功能介绍
查询带宽列表v3
接口约束
无
URI
GET /v3/bandwidth/describe
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| name | 否 | String | 带宽名称 | ||
| realFlag | 否 | Integer | 过滤指定弹性IP类型的带宽。(0-假弹性IP，1-真弹性IP) | ||
| pageNum | 否 | Integer | 页码，至少1，默认1 | ||
| pageSize | 否 | Integer | 每页数量，最大100，默认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 | ||
| name | String | 带宽名称 | ||
| status | String | 状态状态（Creating-创建中;Normal-正常;Deleted-已删除;Changing-变更中;Unhealthy-异常;Frozen-冻结;Deleting-删除中） | ||
| size | Integer | 带宽大小（单位：Mbps） | ||
| vpcOid | String | VPC ID | ||
| subnets | Array of Objects | 子网列表 | subnets | |
| vpcName | String | VPC名称 | ||
| elasticIpAddress | String | 弹性IP地址 | ||
| createTime | String | 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | ||
| expireTime | String | 到期时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 | ||
| resourcePackOid | String | 资源包ID（仅资源包带宽有效） | ||
| billMode | String | 订购类型（仅单独付费带宽有效）。取值范围： - Cycle：包周期。 - OnDemand：按需。 | ||
| chargeType | String | 计费方式（仅单独付费的按需带宽有效）：Bandwidth-固定带宽，Traffic-按流量使用 |
表 subnets
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| subnetOid | String | VPC子网ID | ||
| subnetName | String | 子网名称 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&name=xxx&realFlag=xxx&pageNum=xxx&pageSize=xxx
请求头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"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
