接口功能介绍
查询访问控制规则信息
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/acl-rule/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 每页记录数目 | 10 | |
| search | 否 | String | 模糊查询 | acl | |
| aclID | 是 | String | ACL ID | be012e8f-ea32-4a2c-89da-7db35eedb334 |
请求参数
请求头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 | 页码 | 8 | |
| result | 否 | Array of object | 结果列表 | result |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| aclRuleID | 否 | String | acl rule ID | be012e8f-ea32-4a2c-89da-7db35eedb325 | |
| aclID | 否 | String | acl ID | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| direction | 否 | String | 本参数表示控制方向 取值范围： in：入方向 out：出方向 |
in | |
| action | 否 | String | 本参数表示行为 取值范围： allow：允许 deny：禁止 |
deny | |
| protocol | 否 | String | 本参数表示协议类型 取值范围： icmp：icmp协议 tcp：tcp协议 udp：udp协议 |
tcp | |
| srcCidr | 否 | String | 源网段 | 11.0.0.0/16 | |
| dstCidr | 否 | String | 目的网段 | 10.0.0.0/16 | |
| srcPortRange | 否 | String | 源端口范围（例如1-200， -1/-1为默认值，表示1-65535） | -1/-1 | |
| dstPortRange | 否 | String | 目的端口范围（例如1-200， -1/-1为默认值，表示1-65535） | -1/-1 | |
| priority | 否 | Integer | 优先级，范围1-100 | 50 | |
| status | 否 | String | 本参数表示状态 取值范围: normal:状态正常 creating:正在创建 deleting:正在删除 failed:创建失败 error:删除失败 |
normal |
请求示例
请求url
/v4/sdwan/acl-rule/list?aclID=be012e8f-ea32-4a2c-89da-7db35eedb334
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 1,
"currentCount": 1,
"result": [
{
"aclRuleID": "be012e8f-ea32-4a2c-sdwe-7db35eedb325"
"aclID": "be012e8f-ea32-4a2c-89da-7db35eedb334",
"direction": "in",
"action": "deny",
"protocol": "tcp",
"srcCidr": "11.0.0.0/16",
"dstCidr": "10.0.0.0/16",
"srcPortRange": "-1/-1",
"dstPortRange": "-1/-1",
"priority": 50,
"status": "normal"
}
]
}，
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
