接口功能介绍
查询智能网关弹性带宽包
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /v4/sdwan/elastic-bandwidth-package/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 是 | String | 智能网关ID | 2893f150-19b5-11eb-8e79-824da1059800 |
请求参数
请求header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| result | 否 | Array of Objects | 智能网关APP信息查询 | result | |
| totalCount | 否 | Integer | 总数量 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| bandwidthPackageID | 否 | String | 弹性带宽实例Id | e8a2a33a-6173-11ed-8865-525400af7402 | |
| edgeID | 否 | String | 智能网关Id | b35fcd88-5e7b-11ed-9fa7-525400af7402 | |
| customerID | 否 | String | 用户ID | 19bf37bb87cc4c86aa2542b67b4fa032 | |
| status | 否 | String | 本参数表示带宽状态 取值范围: enable:生效 disable:失效 |
enable | |
| bandwidth | 否 | Integer | 带宽大小 | 5 | |
| resourceID | 否 | String | 资源ID | 44b638ede78e413898953a0f4c777b13 | |
| effectiveTime | 否 | String | 生效时间 | 2023-02-23 03:13:34 | |
| expireTime | 否 | String | 到期时间 | 2023-02-26 03:13:34 |
请求示例
请求url
/v4/sdwan/elastic-bandwidth-package/list?edgeID=82c40584-fe8f-49b0-9e09-ef915caeee10
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"bandwidthPackageID": "e8a2a33a-6173-11ed-8865-525400af7402",
"edgeID": "b35fcd88-5e7b-11ed-9fa7-525400af7402",
"customerID": "19bf37bb87cc4c86aa2542b67b4fa032",
"status": "enable",
"bandwidth": 5,
"resourceID": "44b638ede78e413898953a0f4c777b13",
"effectiveTime": "2023-02-23T03:13:34Z",
"expireTime": "2023-02-26T03:13:34Z"
}
],
"totalCount": 1,
"currentCount": 1,
"errorCode": "",
"message": "",
"description": ""
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| ElasticBandwidthPackage.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
