查询qos规则
更新时间 2026-05-26 14:26:31
最近更新时间: 2026-05-26 14:26:31
接口功能介绍
查询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 | |
| groupType | String | 本参数表示应用组类型 取值范围: system:系统 custom:自定义 | system | |
| apps | Array of Objects | app列表 | apps |
表 apps
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| appName | String | app名称 | 影视TV | |
| appID | String | app id | 57004 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"totalCount": 4,
"result": [
{
"priority": 1,
"rate": 1,
"itemList": [
{
"itemID": "9a702e8e-d80c-11ed-8944-525400af7402",
"dstCidr": "10.11.0.0/16",
"ruleType": "ace",
"protocol": "tcp",
"apps": [
],
"groupType": "",
"dstPortRange": "-1/-1",
"ipVersion": "ipv4",
"srcPortRange": "-1/-1",
"srcCidr": "12.10.0.0/16",
"itemName": "ace-rule-001"
}
],
"ruleType": "ace",
"ruleID": "9a702de4-d80c-11ed-8944-525400af7402"
},
{
"priority": 2,
"rate": 1,
"itemList": [
{
"itemID": "9a70b28c-d80c-11ed-8944-525400af7402",
"dstCidr": "10.12.0.0/16",
"ruleType": "ace",
"protocol": "tcp",
"apps": [
],
"groupType": "",
"dstPortRange": "-1/-1",
"ipVersion": "ipv4",
"srcPortRange": "-1/-1",
"srcCidr": "13.10.0.0/16",
"itemName": "ace-rule-002"
}
],
"ruleType": "ace",
"ruleID": "9a70b1b0-d80c-11ed-8944-525400af7402"
},
{
"priority": 3,
"rate": 2,
"itemList": [
{
"itemID": "9a70ed92-d80c-11ed-8944-525400af7402",
"dstCidr": "",
"ruleType": "app",
"protocol": "tcp",
"apps": [
{
"appID": "57004",
"appName": "影视TV"
}
],
"groupType": "system",
"dstPortRange": "",
"ipVersion": "",
"srcPortRange": "",
"srcCidr": "",
"itemName": "app-group-001"
}
],
"ruleType": "app",
"ruleID": "9a70eca2-d80c-11ed-8944-525400af7402"
},
{
"priority": 5,
"rate": 2,
"itemList": [
{
"itemID": "9a7121a4-d80c-11ed-8944-525400af7402",
"dstCidr": "",
"ruleType": "app",
"protocol": "tcp",
"apps": [
{
"appID": "58004",
"appName": "影视TV113"
}
],
"groupType": "system",
"dstPortRange": "",
"ipVersion": "",
"srcPortRange": "",
"srcCidr": "",
"itemName": "app-group-002"
}
],
"ruleType": "app",
"ruleID": "9a7120e6-d80c-11ed-8944-525400af7402"
}
],
"currentCount": 4
},
"errorCode": "",
"error": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
