接口功能介绍
创建qos
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
POST /v4/sdwan/qos/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| qosName | 是 | String | qos策略名称 | add-qos-002 | |
| projectID | 是 | String | 企业项目名称 | 11 | |
| description | 是 | String | 描述 | add qos | |
| bandwidth | 是 | Integer | 带宽峰值，单位Mbps,当bandwidthType为internet时范围为5-10000,bandwidthType为sdwan时范围为5-1000 | 200 | |
| bandwidthType | 是 | String | 本参数表示带宽类型 取值范围： internet：互联网带宽 sdwan：SD-WAN带宽 |
internet | |
| ruleList | 是 | Array Of Objects | 规则列表 | ruleList |
表ruleList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| priority | 是 | Integer | 优先级,范围1-4 | 1 | |
| rate | 是 | Integer | 速率,单位Mbps,单个速率不能超过带宽 | 1 | |
| ruleType | 是 | String | 本参数表示规则类型 取值范围： ace：五元组 app：应用组 |
ace | |
| aceList | 否 | Array Of Objects | ace规则列表 | aceList | |
| appList | 否 | Array Of Objects | app应用组列表 | appList |
表aceList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| aceRuleName | 是 | String | ace规则策略名称 | ace-rule-001 | |
| protocol | 是 | String | 本参数表示协议类型 取值范围： tcp：tcp协议 udp：udp协议 |
tcp | |
| ipVersion | 是 | String | 本参数表示ip协议版本 取值范围： ipv4：ipv4协议 ipv6：ipv6协议 |
ipv4 | |
| dstCidr | 是 | String | 目的子网 | 10.11.0.0/16 | |
| srcCidr | 是 | String | 源子网 | 12.10.0.0/16 | |
| dstPortRange | 是 | String | 目的端口范围（例如1-200， -1/-1为默认值，表示1-65535） | -1/-1 | |
| srcPortRange | 是 | String | 源端口范围（例如1-200， -1/-1为默认值，表示1-65535） | -1/-1 |
表appList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appGroupName | 是 | String | 应用组名称 | app-group-001 | |
| groupType | 是 | String | 本参数表示应用类型 取值范围： system：系统 custom：自定义 |
custom | |
| apps | 是 | Array Of Objects | app列表 | apps |
表apps
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appName | 是 | String | app名称 | 影视TV | |
| appID | 是 | String | app id | 57004 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Array of Objects | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| operationID | 否 | String | 操作日志Id | 7b80b736-4aa5-11ed-b0e4-005056898fe0 |
请求示例
请求头header
无
请求体body
{
"name": "qos-policy-002",
"projectID": "11",
"description": "qos策略",
"bandwidth": 200,
"bandwidthType": "internet",
"ruleList": [
{
"priority": "1",
"rate": "1",
"ruleType": "ace",
"aceList": [
{
"aceRuleName": "ace-rule-001",
"protocol": "tcp",
"ipVersion": "ipv4",
"dstCidr": "10.11.0.0/16",
"srcCidr": "12.10.0.0/16",
"dstPortRange": "-1/-1",
"srcPortRange": "-1/-1"
}
]
},
{
"priority": "2",
"rate": "2",
"ruleType": "app",
"appList": [
{
"appGroupName": "app-group-001",
"groupType": "system",
"apps": [
{
"appName": "影视TV",
"appID": "57004"
}
]
}
]
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": [
{
"operationID": "7b80b736-4aa5-11ed-b0e4-005056898fe0"
}
],
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Qos.SdwanSdwan.CreateError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
