DescribeAddressBook - Cloud Firewall - Alibaba Cloud Documentation Center

Queries a list of address books.

Operation description

This operation queries the details of address books used in access control policies.

QPS limit

The queries per second (QPS) limit for this API call is 10 per user. If you exceed the limit, your API calls are throttled. This may affect your business. Plan your API calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Valid values: en : English zh : Chinese (default)	zh
CurrentPage	string	No	The number of the page to return. Default value: 1.	1
PageSize	string	No	The number of entries to return on each page. Default value: 10. Maximum value: 50.	10
Query	string	No	The search keyword for the address book.	192.0.XX.XX
GroupType	string	No	The type of the address book. Note If you do not specify this parameter, address books of the ip and tag types are queried. Valid values: allCloud : cloud service address book port : port address book ipv6 : IPv6 address book ip : IPv4 address book (default) domain : domain name address book ack : ACK address book tag : ECS tag address book threat : threat intelligence address book	ip
ContainPort	string	No	The port that is included in the address book. This parameter takes effect only when you set GroupType to port.	80

Response elements

Element	Type	Description	Example
	object
PageNo	string	The page number.	1
PageSize	string	The number of entries returned per page.	10
RequestId	string	The request ID.	B36F150A-1E27-43AA-B72C-D2AC712F09DA
TotalCount	string	The total number of address books.	100
Acls	array<object>	The list of address books.
	array<object>	The details of the address book.
AddressListCount	integer	The number of addresses in the address book.	2
GroupUuid	string	The unique ID of the address book.	f04ac7ce-628b-4cb7-be61-310222b7****
AutoAddTagEcs	integer	Indicates whether to automatically add the public IP addresses of ECS instances to the address book if the instances have the specified tags. Valid values: 0 : no 1 : yes	1
Description	string	The description of the address book.	DEMO地址簿
GroupName	string	The name of the address book.	demo_address_book
ReferenceCount	integer	The number of times the address book is referenced.	3
GroupType	string	The type of the address book. Valid values: allCloud : cloud service address book port : port address book ipv6 : IPv6 address book ip : IPv4 address book ack : ACK address book tag : ECS tag address book threat : threat intelligence address book	ip
TagRelation	string	The logical relationship among multiple ECS tags. Valid values: or : An OR logical relationship. The public IP address of an ECS instance is added to the address book if the ECS instance has any of the specified tags. and : An AND logical relationship. The public IP address of an ECS instance is added to the address book only if the ECS instance has all the specified tags.	and
TagList	array<object>	The list of ECS tags.
	object	The ECS tag.
TagValue	string	The value of the ECS tag.	全部VALUE
TagKey	string	The key of the ECS tag.	company
AddressList	array	The list of addresses in the address book.
	string	The address in the address book.	[ "192.168.XX.XX/32", "192.168.XX.XX/32" ]
Addresses	array<object>	The list of addresses that have remarks.
	object	The address that has a remark.
Address	string	The address.	192.168.0.1/32
Note	string	The remark for the address.	单地址描述
AckClusterConnectorId	string	The ID of the ACK cluster connector.	ac-7c1bad6c3cc84c33baab
AckClusterConnectorName	string	The name of the ACK cluster connector.	ack-cluster-connector-name
AckLabels	array<object>	The list of pod labels in the ACK cluster.
	object	A label of a pod in the ACK cluster.
Key	string	The key of the pod label.	app
Value	string	The value of the pod label.	storage-operator
AckNamespaces	array	The list of pod namespaces in the ACK cluster.
	string	A namespace of a pod in the ACK cluster.	default
RegionNo	string	The region of the ACK cluster connector. This parameter is returned only when GroupType is ack.	cn-beijing

Examples

Success response

JSON format

{
  "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": "全部VALUE",
          "TagKey": "company"
        }
      ],
      "AddressList": [
        "[ \"192.168.XX.XX/32\", \"192.168.XX.XX/32\" ]"
      ],
      "Addresses": [
        {
          "Address": "192.168.0.1/32",
          "Note": "单地址描述"
        }
      ],
      "AckClusterConnectorId": "ac-7c1bad6c3cc84c33baab",
      "AckClusterConnectorName": "ack-cluster-connector-name",
      "AckLabels": [
        {
          "Key": "app",
          "Value": "storage-operator"
        }
      ],
      "AckNamespaces": [
        "default"
      ],
      "RegionNo": "cn-beijing"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParametersGroupType	The group type is invalid.	The group type is invalid.
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.	Either pageSize or pageNo is invalid.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.