接口功能介绍
查询智能网关APP带宽
接口约束
无
URI
GET /v4/sdwan/sdwan-app-bandwidth/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 页大小 | 10 |
请求参数
请求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
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| bandwidthID | 否 | String | 实例ID | 397171e0-6013-11ed-837f-005056893e3e | |
| account | 否 | String | 用户邮箱 | openapiuser@chinatelecom.cn | |
| customerID | 否 | String | customer的id | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| status | 否 | String | 状态 | 本参数表示状态 取值范围: created:已开通 actived:已激活 refistered:已注册 |
|
| bandwidth | 否 | Integer | 带宽大小 | 20 | |
| username | 否 | String | 客户端账号 | user-001 | |
| startTime | 否 | String | 起始时间 | 2022-11-02 02:00:00 | |
| expireTime | 否 | String | 到期时间 | 2022-11-09 03:00:00 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"bandwidthID": "397171e0-6013-11ed-837f-005056893e3e",
"account": "openapiuser@chinatelecom.cn",
"customerID": "be012e8f-ea32-4a2c-89da-7db35eedb334",
"status": "created",
"bandwidth": 20,
"username": "user-001",
"startTime": "2022-11-02 02:00:00",
"expireTime": "2022-11-09 03:00:00"
}
],
"totalCount": 1,
"currentCount": 1
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| MobileOffice.PatternCheck.NotValid | 请求参数无效 |
| MobileOffice.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
附录
无
