接口功能介绍
应用创建
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
POST /v4/sdwan/app/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| groupID | 是 | String | 所属应用组ID,范围在58-99 | 59 | |
| appName | 是 | String | 创建应用名称 | app-001 | |
| ruleType | 是 | String | 本参数表示规则类型 取值范围： ace：五元组 hostname：访问地址 |
ace | |
| ruleList | 否 | Array Of Objects | 规则列表 | ruleList |
表ruleList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| srcCidr | 否 | String | 源网段（ruleType为ace必填） | 10.20.0.0/16 | |
| srcPort | 否 | String | 源端口范围（ruleType为ace必填） | 50,70 | |
| dstCidr | 否 | String | 目的网段（ruleType为ace必填） | 10.10.0.0/16 | |
| dstPort | 否 | String | 目的端口范围（ruleType为ace必填） | 110,120 | |
| protocol | 否 | String | 本参数表示协议类型（ruleType为ace必填）取值范围： icmp：icmp协议 tcp：tcp协议 udp：udp协议 |
tcp | |
| hostname | 否 | String | 访问地址(和前面所有参数二选一，要不只填这个，要不填前面的参数) | ctyun.com |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| operationID | 否 | String | 操作id | 2667c06e-4a0f-11ed-b0e4-005056898fe0 |
请求示例
请求头header
无
请求体body
{
"groupID": "59",
"appName": "app-123",
"ruleType": "ace",
"ruleList": [{
"srcCidr": "32.3.4.0/24",
"srcPort": "10,30",
"dstCidr": "33.4.3.0/24",
"dstPort": "50,70",
"protocol": "tcp",
"hostname": "hostname"
}]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 1,
"currentCount": 1,
"result": [
{
"operationID": "2667c06e-4a0f-11ed-b0e4-005056898fe0"
}
]
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
