接口功能介绍
查询ACL规则列表
接口约束
无
URI
GET /v3/aclRule/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| aclOid | 是 | String | ACL ID | acl-ixpc4edyti2kx9c1q7dvy | |
| direction | 是 | String | 方向（ingress-入方向;egress-出方向） | ingress | |
| strategy | 否 | String | 策略（allow-允许；deny-拒绝） | null | |
| protocol | 否 | String | 协议（tcp-TCP协议;udp-UDP协议;all-全部协议;icmpv4-ICMPv4协议;icmpv6-ICMPv6协议） | null | |
| sourceAddress | 否 | String | 源地址 | null | |
| destinationAddress | 否 | String | 目的地址 | null | |
| pageNum | 否 | Integer | 页码，至少1，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，最大100，默认10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ||
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | { } | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | 1 | |
| list | Array of Objects | 数据列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| aclRuleOid | String | ACL规则ID | arl-cjiwt04l2c3sk7137cn99 | |
| name | String | ACL规则名称 | 222 | |
| order | Integer | 优先级，值越小优先级越高，最小为1 | 1 | |
| enabled | Boolean | 是否启用 | true | enabled |
| manageStatus | String | 管理状态（Deleted-已删除;Active-已激活;Creating-创建中;Deleting-删除中;Unhealthy-异常;Processing-处理中） | Active | |
| type | String | 类型（ipv4-IPv4;ipv6-IPv6） | ipv6 | |
| strategy | String | 策略（allow-允许；deny-拒绝） | deny | |
| protocol | String | 协议（tcp-TCP协议;udp-UDP协议;all-全部协议;icmpv4-ICMPv4协议;icmpv6-ICMPv6协议） | tcp | |
| sourceAddress | String | 源地址 | ::/0 | |
| sourcePort | String | 源端口范围。若为空，则表示全部端口（1-65535） | null | |
| destinationAddress | String | 目的地址 | ::/0 | |
| destinationPort | String | 目的端口范围。若为空，则表示全部端口（1-65535） | null | |
| description | String | 描述 | decs-zYUV7w6E |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"aclRuleOid":"arl-xxx","name":"foo","order":1,"enabled":true,"manageStatus":"Active","type":"ipv4","strategy":"allow","protocol":"all","sourceAddress":"0.0.0.0/0","destinationAddress":"0.0.0.0/0","description":""}]}}
状态码
请参考 状态码
错误码
请参考 错误码
