接口功能介绍
查询已绑定acl的盒子信息
接口约束
输入参数名称类长度不超过64位,描述类长度不超过128位
pageNo和pageSize从1开始,不能小于1
URI
GET /v4/sdwan/acl-edge/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
pageNo | 否 | Integer | 页码 | 1 | |
pageSize | 否 | Integer | 每页计算数目 | 10 | |
search | 否 | String | 模糊查询 | acl | |
aclID | 是 | String | acl ID | 14eba528-bd80-11ed-a12a-005056893e3e |
请求参数
请求头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
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
edgeName | 否 | String | 盒子名称 | edge-001 | |
edgeID | 否 | String | 盒子ID | ac012e8f-ea32-4a2c-89da-7db35eedb334 | |
sdwanName | 否 | String | sdwan名称 | SDWAN-001 | |
status | 否 | String | 本参数表示协议 取值范围: success:成功 error:错误 binding:绑定 |
success | |
sdwanID | 否 | String | sdwan ID | bc012e8f-ea32-4a2c-89da-7db35eedb334 |
请求示例
请求url
/v4/sdwan/acl-edge/list?aclID=14eba528-bd80-11ed-a12a-005056893e3e
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"message": "",
"totalCount": 1,
"currentCount": 1,
"code": "200",
"result": [
{
"edgeName": "TEST_001",
"edgeID": "ac012e8f-ea32-4a2c-89da-7db35eedb334",
"sdwanName": "SDWAN_TEST_001",
"status": "success",
"sdwanID": "bc012e8f-ea32-4a2c-89da-7db35eedb334"
}
]
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |