URI
GET https://ecpc-[regionCode].ctapi.ctyun.cn/v2/bandwith/describe
URI参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
name | string | 否 | 带宽名称 |
pageNum | int | 否 | 页码,至少1,默认1 |
pageSize | int | 否 | 每页数量,最大100,默认10 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
code | int | 状态码 |
msg | string | 返回消息(如有必要) |
data | PageResult | 返回数据对象 |
返回相关类型定义
PageResult
名称 | 类型 | 描述 |
---|---|---|
total | long | 总记录数 |
list | DescribeBandwidthResult[] | 数据列表 |
DescribeBandwidthResult
名称 | 类型 | 描述 |
---|---|---|
bandwidthOid | string | 带宽ID |
name | string | 带宽名称 |
status | string | 状态状态(Creating-创建中;Normal-正常;Deleted-已删除;Changing-变更中;Unhealthy-异常;Frozen-冻结;Deleting-删除中) |
size | int | 带宽大小(单位:Mbps) |
vpcOid | string | VPC ID |
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。 |
示例
请求示例
GET https://ecpc-[regionCode].ctapi.ctyun.cn/v2/bandwith/describe?name=fooName
正常返回示例
{
"code":0,
"data":{
"total":1,
"list":[{
"bandwidthOid":"bw-foo",
"name":"bandwidth-xxx",
"status":"Creating",
"size":1,
"vpcOid":"vpc-xxx",
"vpcName":"vpc-xxx",
"elasticIpAddress":null,
"createTime":"2022-08-24T09:01:58Z",
"expireTime":"2026-01-11T02:27:53Z"
}]
}
}