接口功能介绍
应用查询
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/app/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 每页记录数目 | 1 | |
| search | 否 | String | 模糊查询 | app | |
| groupID | 否 | String | 所属应用组ID | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| appType | 否 | String | 本参数表示应用类型 取值范围： system：系统 custom：自定义 |
system | |
| appID | 否 | String | 应用ID | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| appName | 否 | String | 应用名称 | app57004 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 总数 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 | |
| result | 否 | Array of Objects | 列表 | result |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appName | 否 | String | 模糊搜索应用组名称 | app57004 | |
| appID | 否 | String | 应用ID | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| appType | 否 | String | 本参数表示应用类型 取值范围: custom:自定义 system:系统 |
system | |
| customerID | 否 | String | 用户ID | bac_9eb5d50887d1442d9feae0b598c3297e | |
| createdTime | 否 | String | 创建时间 | 2020-10-20 06:42:17 | |
| ruleType | 是 | String | 本参数表示规则类型 取值范围: hostname:网络域名 ace:五元组 |
ace | |
| ruleList | 否 | Array of Objects | 规则列表 | ruleList | |
| group | 否 | Object | 所属应用组 | group |
表ruleList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| protocol | 否 | String | 本参数表示协议 取值范围: tcp:tcp udp:udp icmp:icmp |
tcp | |
| srcCidr | 否 | String | 源网段 | 10.20.0.0/16 | |
| srcPort | 否 | String | 源端口范围（范围1-65535） | 10,20 | |
| dstCidr | 否 | String | 目的网段 | 10.10.0.0/16 | |
| dstPort | 否 | String | 目的端口范围（范围1-65535） | 30，50 | |
| hostname | 否 | String | 访问地址(和前面所有参数二选一，要不只填这个，要不填前面的参数) | hostname |
表group
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| groupName | 否 | String | 应用组名称 | group-name | |
| groupID | 否 | String | group_id | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| groupType | 否 | String | 本参数表示应用组类型 取值范围: custom:自定义 system:系统 |
custom | |
| customerID | 否 | String | 用户ID | bac_9eb5d50887d1442d9feae0b598c3297e |
请求示例
请求url
/v4/sdwan/app/list?groupID=59
请求头header
无
请求体body
无
响应示例
{
"returnObj":{
"currentCount":1,
"totalCount":1,
"result":[
{
"ruleType":"ace",
"group":{
"groupType":"custom",
"groupName":"其他",
"groupID":"59",
"customerID":"19bf37bb87cc4c86aa2542b06b4fa032"
},
"ruleList":[
],
"appType":"custom",
"appID":"56002",
"appName":"阿里应用",
"customerID":"19bf37bb87cc4c86aa2542b06b4fa032"
}
]
},
"errorCode":"",
"message":"",
"description":"",
"statusCode":800
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
