接口功能介绍
应用组查询
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/app-group/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 每页记录数目 | 10 | |
| search | 否 | String | 模糊查询 | app | |
| groupName | 否 | String | 应组组名称 | app-group-001 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | retunObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 总数 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 | |
| result | 否 | Array of object | 列表 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| groupName | 否 | String | group_name | app-group-001 | |
| groupID | 否 | String | group_id | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| groupType | 否 | String | 本参数表示应用类型 取值范围： system：系统 custom：自定义 |
custom | |
| customerID | 否 | String | 用户ID | bac_9eb5d50887d1442d9feae0b598c3297e |
请求示例
请求url
/v4/sdwan/app-group/list?pageNo=1
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 1,
"currentCount": 1,
"result": [
{
"groupName": "group-001",
"groupID": "59",
"groupType": "system",
"customerID": "xxx",
}
]
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
