查詢ACL規則列表v3
更新時間 2024-06-04 11:04:10
最近更新時間: 2024-06-04 11:04:10
分享文章
接口功能介紹
查詢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":""}]}}
狀態碼
請參考
錯誤碼
請參考
