接口功能介绍
应用修改
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
POST /v4/sdwan/app/update
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appID | 是 | String | 应用ID,自定义分配ID号，范围为57000-57999 | 57002 | |
| appName | 是 | String | 应用名称 | app-001 | |
| addRuleList | 否 | Array Of Objects | 增加规则列表(只支持五元组) | addRuleList | |
| deleteRuleList | 否 | Array Of Integers | 删除规则列表(只支持五元组，当还剩一条规则不能删) | [2,3] | |
| modifyRule | 否 | Object | 修改规则(只剩一条规则时能用) | modifyRule |
表addRuleList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| srcCidr | 是 | String | 源网段 | 10.20.0.0/16 | |
| srcPort | 是 | String | 源端口范围 | 10,20 | |
| dstCidr | 是 | String | 目的网段 | 10.10.0.0/16 | |
| dstPort | 是 | String | 目的端口范围 | 30,50 | |
| protocol | 是 | String | 协议类型 | 本参数表示协议类型 取值范围： tcp：tcp协议 udp：udp协议 icmp：icmp协议 |
表modifyRule
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ruleID | 是 | String | 规则ID | 3 | |
| srcCidr | 否 | String | 源网段，当ruleType为ace必填 | 10.20.0.0/16 | |
| srcPort | 否 | String | 源端口范围，范围1-65535，以逗号格式分割，当ruleType为ace必填 | 60,70 | |
| dstCidr | 否 | String | 目的网段，当ruleType为ace必填 | 10.10.0.0/16 | |
| dstPort | 否 | String | 目的端口范围，范围1-65535，以逗号格式分割，当ruleType为ace必填 | 80,90 | |
| protocol | 否 | String | 协议类型 | 本参数表示协议类型 取值范围： tcp：tcp协议 udp：udp协议 icmp：icmp协议 |
|
| hostname | 否 | String | 访问地址，当ruleType为hostname必填 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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
{
"appID": "57002",
"appName": "app-001",
"addRuleList": [
{
"srcCidr": "10.20.0.0/16",
"srcPort": "30,50",
"dstCidr": "10.10.0.0/16",
"dstPort": "50,70",
"protocol": "tcp"
}
],
"deleteRuleList": [],
"modifyRule": {
"ruleID": "12578e8f-ea32-4a2c-89da-7db35eedb334",
"hostname": "天翼云生产机",
"srcCidr": "10.20.0.0/16",
"srcPort": "100,120",
"dstCidr": "10.10.0.0/16",
"dstPort": "130,150",
"protocol": "tcp"
}
}
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 1,
"currentCount": 1,
"result": [
{
"operationID": "2667c06e-4a0f-11ed-b0e4-005056898fe0"
}
]
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
