接口功能介绍
查询qos规则
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
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 |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| result | 否 | Array of Objects | 查询qos规则 | result | |
| totalCount | 否 | Integer | 总数量 | 1 | |
| currentCount | 否 | Integer | 页码 | 1 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ruleID | 否 | String | 规则id | 472e1ff0-4a9b-11ed-b0e4-005056898fe0 | |
| priority | 否 | Integer | 优先级，范围1-4 | 1 | |
| rate | 否 | Integer | 速率 | 1 | |
| ruleType | 否 | String | 本参数表示规则类型 取值范围： ace：五元组 app：应用组 |
ace | |
| itemList | 否 | Array of Objects | qos规则元素列表 | itemList |
表itemList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dstCidr | 否 | String | 目的子网 | 10.11.0.0/16 | |
| groupType | 否 | String | 本参数表示应用组类型 取值范围： system：系统 custom：自定义 |
system | |
| ruleType | 否 | String | 本参数表示规则类型 取值范围： ace：五元组 app：应用组） |
ace | |
| protocol | 否 | String | 本参数表示协议类型 取值范围： tcp：tcp协议 udp：udp协议 |
tcp | |
| itemName | 否 | String | 五元组/应用组名称 | ace-001 | |
| dstPortRange | 否 | String | 目的端口范围（例如1-200， -1/-1为默认值，表示1-65535) | -1/-1 | |
| ipVersion | 否 | String | 本参数表示ip协议版本 取值范围： ipv4：ipv4协议 ipv6：ipv6协议 |
ipv4 | |
| itemID | 否 | String | 五元组/应用组 ID | 152ed6fc-64ef-11ed-af3c-525400af7402 | |
| srcPortRange | 否 | String | 源端口范围（例如1-200， -1/-1为默认值，表示1-65535) | -1/-1 | |
| srcCidr | 否 | String | 源子网 | 12.10.0.0/16 | |
| apps | 否 | Array of Objects | 应用组 | apps |
表apps
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appID | 否 | string | 应用ID | 58004 | |
| appName | 否 | string | 应用名称 | 影视TV |
请求示例
请求url
/v4/sdwan/qos-rule/list?qosID=472a8c3c-4a9b-11ed-b0e4-005056898fe0
请求头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"
}],
"curentCount": 4
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| QosRule.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
