查询带宽包
接口功能介绍
查询带宽包
接口约束
无
URI
GET /v4/ec/bandwidth-packet/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| packetID | 否 | String | 带宽包ID | 7c84cfa9-a997-4281-af8a-3c765c25d0be | |
| resourceID | 否 | String | 带宽包 resource ID | 795158016fed44fa9867433c9f162ed6 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentCount | 否 | Integer | 当前页记录数 | 3 | |
| totalPage | 否 | Integer | 总页数 | 1 | |
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| packetID | 否 | String | 带宽包ID | 7c84cfa9-a997-4281-af8a-3c765c25d0be | |
| packetName | 否 | String | 带宽包名称 | crossnetwork-368e | |
| resourceID | 否 | String | 订单资源ID | 795158016fed44fa9867433c9f162ed6 | |
| rate | 否 | Integer | 带宽（MB） | 10 | |
| status | 否 | Integer | 运行状态， 取值范围: 0:创建中 2:运行中 18:删除中 21:设置中 22:更新带宽中 24:更新中 |
2 | |
| areaA | 否 | String | 区域A类型 "china": 中国大陆, "APAC":亚太 默认china |
china | |
| areaB | 否 | String | 区域B类型 "china": 中国大陆, "APAC":亚太 默认china |
china | |
| ecID | 否 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| createDate | 否 | String | 创建时间 | 2022-09-19 02:05:28 | |
| deleteDate | 否 | String | 到期时间 | 2022-09-19 02:05:28 | |
| billingModel | 否 | String | 计费类型，默认为空（包年包月） | ||
| usedRate | 否 | Integer | 已用带宽（MB） | 10 | |
| usableRate | 否 | Integer | 剩余可用带宽（MB） | 10 | |
| resourceType | 否 | String | 带宽包类型，取值范围： "china":"境内" ""APAC":"亚太" ""cross":"跨境" ""specific":"定制" |
china |
请求示例
请求url
v4/ec/bandwidth-packet/list?ecID=82c40584-fe8f-49b0-9e09-ef915caeee10
请求头header
无
请求体body
无
响应示例
{
"description":"",
"errorCode":"",
"message":"",
"statusCode":800,
"traceID":"2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj":{
"totalCount":1,
"totalPage":1,
"currentCount":1,
"results":[
{
"packetID": "7c84cfa9-a997-4281-af8a-3c765c25d0be",
"packetName": "crossnetwork-368e",
"resourceID": "795158016fed44fa9867433c9f162ed6",
"rate": 10,
"status": 2,
"areaA": "china",
"areaB": "china",
"ecID": "82c40584-fe8f-49b0-9e09-ef915caeee10",
"createDate": "2022-09-19 02:05:28",
"deleteDate": "2022-09-19 02:05:28",
"billingModel": "",
"usedRate":2,
"usableRate":8,
"resourceType":"china"
}
]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.PacketEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
