使用DescribeAddressBook介面批量查詢地址簿列表-Cloud Firewall-阿里雲

批量查詢地址簿列表。

介面說明

本介面一般用於查詢存取控制策略地址簿的詳細資料。

QPS 限制

本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
Lang	string	否	地址簿描述的語言類型。枚舉值： en : 英文 zh : 中文（預設）	zh
CurrentPage	string	否	分頁查詢時，設定當前頁面的頁碼。預設值為 1，表示返回第 1 頁資料。	1
PageSize	string	否	分頁查詢時，設定每頁包含的地址簿的數量。預設值為 10，表示每頁包含 10 條結果。最大值為 50。	10
Query	string	否	搜尋條件，輸入待查詢地址簿資訊。	192.0.XX.XX
GroupType	string	否	地址簿的類型。說明不設定該參數表示查詢 IP 位址簿和 ECS 標籤地址簿。枚舉值： allCloud : 雲端服務地址簿 port : 連接埠地址簿 ipv6 : IPv6 地址簿 ip : IPv4 地址簿（預設） domain : 網域名稱地址簿 ack : ACK 地址簿 tag : ECS 標籤地址簿 threat : 情報地址簿	ip
ContainPort	string	否	查詢包含指定連接埠的地址簿。僅當 GroupType 參數的值為 port 時，該參數才會作為本次查詢的條件。	80
GroupUuid	string	否	地址簿的唯一標識 ID。	f04ac7ce-628b-4cb7-be61-310222b7****

返回參數

名稱	類型	描述	樣本值
	object
PageNo	string	當前頁面的頁碼。	1
PageSize	string	每頁包含的地址簿的數量。	10
RequestId	string	結果的請求 ID。	B36F150A-1E27-43AA-B72C-D2AC712F09DA
TotalCount	string	地址簿的總數量。	100
Acls	array<object>	地址簿列表。
	array<object>	地址簿資訊。
AddressListCount	integer	地址簿中包含地址的個數。	2
GroupUuid	string	地址簿的唯一標識 ID。	f04ac7ce-628b-4cb7-be61-310222b7****
AutoAddTagEcs	integer	是否自動添加新匹配標籤的 ECS（新購且完成標籤設定的 ECS 或修改標籤的 ECS）公網 IP 到地址簿。枚舉值： 0 : 不自動添加 1 : 自動添加	1
Description	string	地址簿的描述資訊。	DEMO
GroupName	string	地址簿的名稱。	demo_address_book
ReferenceCount	integer	地址簿被引用次數。	3
GroupType	string	地址簿的類型。枚舉值： allCloud : 雲端服務地址簿 port : 連接埠地址簿 ipv6 : IPv6 地址簿 ip : IPv4 地址簿 ack : ACK 地址簿 tag : ECS 標籤地址簿 threat : 情報地址簿	ip
TagRelation	string	多個 ECS 標籤間的關係。枚舉值： or : 多個標籤間為“或”關係，即只要匹配一個標籤的 ECS 公網 IP 就會被加入地址簿。 and : 多個標籤間為“與”關係，即同時匹配多個標籤的 ECS 公網 IP 才會被加入地址簿。	and
TagList	array<object>	ECS 標籤列表。
	object	ECS 標籤。
TagValue	string	ECS 標籤值。	ALL VALUE
TagKey	string	ECS 標籤鍵。	company
AddressList	array	地址簿的地址清單。
	string	地址簿的地址資訊。	[ "192.168.XX.XX/32", "192.168.XX.XX/32" ]
Addresses	array<object>	地址簿的含單地址描述的地址清單。
	object	地址簿的含單地址描述的地址。
Address	string	地址簿的地址資訊。	192.168.0.1/32
Note	string	單地址描述。	Single Address Description
AckClusterConnectorId	string	ACK 叢集連接器 ID。	ac-7c1bad6c3cc84c33baab
AckClusterConnectorName	string	ACK 叢集連接器名稱。	ack-cluster-connector-name
AckLabels	array<object>	ACK 叢集容器組標籤列表。
	object	ACK 叢集容器組標籤。
Key	string	ACK 叢集容器組標籤的鍵。	app
Value	string	ACK 叢集容器組標籤的值。	storage-operator
AckNamespaces	array	ACK 叢集容器組命名空間列表。
	string	ACK 叢集容器組命名空間。	default
RegionNo	string	當 GroupType 是 ACK 地址簿時，地址簿所屬的 ACK 叢集連接器的地區。	cn-beijing

樣本

正常返回樣本

JSON格式

{
  "PageNo": "1",
  "PageSize": "10",
  "RequestId": "B36F150A-1E27-43AA-B72C-D2AC712F09DA",
  "TotalCount": "100",
  "Acls": [
    {
      "AddressListCount": 2,
      "GroupUuid": "f04ac7ce-628b-4cb7-be61-310222b7****",
      "AutoAddTagEcs": 1,
      "Description": "DEMO",
      "GroupName": "demo_address_book",
      "ReferenceCount": 3,
      "GroupType": "ip",
      "TagRelation": "and",
      "TagList": [
        {
          "TagValue": "ALL VALUE",
          "TagKey": "company"
        }
      ],
      "AddressList": [
        "[ \"192.168.XX.XX/32\", \"192.168.XX.XX/32\" ]"
      ],
      "Addresses": [
        {
          "Address": "192.168.0.1/32",
          "Note": "Single Address Description"
        }
      ],
      "AckClusterConnectorId": "ac-7c1bad6c3cc84c33baab",
      "AckClusterConnectorName": "ack-cluster-connector-name",
      "AckLabels": [
        {
          "Key": "app",
          "Value": "storage-operator"
        }
      ],
      "AckNamespaces": [
        "default"
      ],
      "RegionNo": "cn-beijing"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	ErrorParametersGroupType	The group type is invalid.	無效的group類型
400	ErrorParametersUid	The aliUid parameter is invalid.	aliUid 不合法
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.	無效的pageSize或者pageNo
400	ErrorDBSelect	An error occurred while querying database.	內部錯誤：資料庫查詢錯誤

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。