查询qos规则
更新时间 2026-07-31 16:12:19
最近更新时间: 2026-07-31 16:12:19
接口功能介绍
查询qos规则
接口约束
无
URI
GET /v4/sdwan/qos-rule/list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| qosID | 是 | String | qos策略ID | 472a8c3c-4a9b-11ed-b0e4-005056898fe0 | |
| 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 | |
| error | String | 业务细分码，为product.module.code三段式码 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Array of Objects | 查询qos规则 | result | |
| totalCount | Integer | 总数量 | 1 | |
| currentCount | Integer | 页码 | 1 |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ruleID | String | 规则id | 472a8e62-4a9b-11ed-b0e4-005056898fe0 | |
| priority | String | 优先级 | 1 | |
| rate | String | 速率 | 1 | |
| ruleType | String | 本参数表示规则类型 取值范围: ace:五元组 app:应用组 | ||
| itemList | Array of Objects | qos规则元素列表 | itemList |
表 itemList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| itemID | String | qos策略应用实例ID | 9a702e8e-d80c-11ed-8944-525400af7402 | |
| itemName | String | qos规则五元组/应用组名称 | ace-rule-001 | |
| protocol | String | 协议 | 本参数表示协议 取值范围: tcp:tcp udp:udp icmp:icmp | tcp |
| ipVersion | String | 本参数表示ip版本 取值范围: ipv4:ipv4 ipv6:ipv6 | ipv4 | |
| dstCidr | String | 目的子网 | 10.11.0.0/16 | |
| dstPortRange | String | 目的端口范围（例如1-200， -1/-1为默认值，表示1-65535) | -1/-1 | |
| srcCidr | String | 源子网 | 12.10.0.0/16 | |
| srcPortRange | String | 源端口范围（例如1-200， -1/-1为默认值，表示1-65535) | -1/-1 | |
| ruleType | String | 本参数表示规则类型 取值范围: ace:五元组 app:应用组 | ace | |
| appGroups | Array of Objects | 应用组列表 | system | appGroups |
| apps | Array of Objects | app列表 | apps |
表 appGroups
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| appGroupName | String | 应用组名称 | 网络管控 | |
| appGroupID | String | 应用组ID | 55 | |
| groupType | String | 本参数表示应用组类型 取值范围: system:系统 custom:自定义 | system | |
| appCount | String | 应用组包含应用的个数 | 1 |
表 apps
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| groupType | String | 本参数表示应用组类型 取值范围: system:系统 custom:自定义 | system | |
| appGroupID | String | 应用组ID | 55 | |
| appCount | String | 应用组包含应用的个数 | 1 | |
| appGroupName | String | 应用组名称 | 网络管控 | |
| appInfos | Array of Objects | app信息说明 | appInfos |
表 appInfos
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| appName | String | 应用名称 | Diameter | |
| appID | String | 应用ID | 55017 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"result": [
{
"priority": 1,
"limitType": "rate",
"rate": 1,
"itemList": [
{
"itemID": "a477d41e-8cb2-11f1-9510-525400aa4cb4",
"dstCidr": null,
"ruleType": "app",
"protocol": null,
"apps": [
{
"groupType": "system",
"appGroupID": "47",
"appInfos": [
{
"appName": "京东",
"appID": "47000"
}
],
"appCount": 1,
"appGroupName": "购物比价"
}
],
"dstPortRange": null,
"ipVersion": null,
"srcPortRange": null,
"srcCidr": null,
"appGroups": [
],
"itemName": null
}
],
"ruleID": "a477d324-8cb2-11f1-9510-525400aa4cb4",
"ruleType": "app"
},
{
"priority": 4,
"limitType": "rate",
"rate": 1,
"itemList": [
{
"itemID": "a2c9a75a-8cb2-11f1-9510-525400aa4cb4",
"dstCidr": "10.11.0.0/16",
"ruleType": "ace",
"protocol": "tcp",
"apps": null,
"dstPortRange": "-1/-1",
"ipVersion": "ipv4",
"srcPortRange": "-1/-1",
"srcCidr": "12.10.0.0/16",
"appGroups": null,
"itemName": "ace-rule-001"
}
],
"ruleID": "a2c9a69c-8cb2-11f1-9510-525400aa4cb4",
"ruleType": "ace"
}
]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
