接口功能介绍
查询qos
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/qos/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| projectID | 否 | String | 企业项目名称 | 11 | |
| qosID | 否 | String | qos策略ID | 472a8c3c-4a9b-11ed-b0e4-005056898fe0 | |
| qosName | 否 | String | qos策略名称 | add-qos-002 | |
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 页大小 | 10 | |
| search | 否 | String | 模糊查询 | add |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Array of Objects | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| result | 否 | Array of Objects | 查询qos | result | |
| totalCount | 否 | Integer | 总数量 | 1 | |
| currentCount | 否 | integer | 当前页数量 | 1 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| qosID | 否 | string | qos策略ID | 472a8c3c-4a9b-11ed-b0e4-005056898fe0 | |
| qosName | 否 | String | qos策略名称 | add-qos-002 | |
| description | 否 | String | 描述 | add qos | |
| projectID | 否 | String | 企业项目名称 | 11 | |
| bandwidth | 否 | Integer | 带宽峰值 | 200 | |
| bandwidthType | 否 | String | 本参数表示带宽类型 取值范围： internet：互联网带宽 sdwan：SD-WAN带宽 |
internet | |
| ruleCount | 否 | Integer | 规则数 | 2 | |
| edgeCount | 否 | Integer | 关联实例数 | 0 |
请求示例
请求url
/v4/sdwan/qos/list?pageNo=1
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"qosID": "472a8c3c-4a9b-11ed-b0e4-005056898fe0",
"qosName": "qos-policy-002",
"description": "qos策略",
"projectID": "11",
"bandwidth": 200,
"bandwidthType": "internet",
"ruleCount": 2,
"edgeCount": 0
}
],
"totalCount": 1,
"currentCount": 1
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Qos.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
