Query a list of address books using DescribeAddressBook - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Queries address books in batches.

Operation description

This operation is used to query the details of access control policy address books.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable frequency.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribeAddressBook

get

*AddressBook

acs:cloudfirewall::{#accountId}:addressbook/{#GroupUuid}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type for the address book description. Valid values: en: English. zh: Chinese (default). Valid values: en : English. zh : Chinese (default)	zh
CurrentPage	string	No	The page number in a paged query. Default value: 1, which indicates that the first page of data is returned.	1
PageSize	string	No	The number of address books on each page in a paged query. Default value: 10, which indicates that each page contains 10 results. Maximum value: 50.	10
Query	string	No	The search condition. Enter the address book information that you want to query.	192.0.XX.XX
GroupType	string	No	The type of the address book. Note If you do not set this parameter, IP address books and ECS tag-based address books are queried. Valid values: allCloud : cloud service address book. port : port address book. ipv6 : IPv6 address book. ip : IPv4 address book. domain : domain name address book. ack : ACK address book. tag : ECS tag-based public network address book. threat : threat intelligence address book. tagPrivate : ECS label-based private endpoint address book. backsrcIpv6 : IPv6 back-to-origin address book. ackLabel : ACK pod label address book. cloud : cloud address book. cloudServiceDomain : cloud service domain name address book. backsrc : IPv4 back-to-origin address book. cloudDomain : cloud domain name address book. assetIpv6 : IPv6 public assets address book. ackNamespace : ACK namespace address book. asset : IPv4 public assets address book.	ip
ContainPort	string	No	Queries address books that contain the specified port. This parameter takes effect only when the GroupType parameter is set to port.	80
GroupUuid	string	No	The unique ID of the address book.	f04ac7ce-628b-4cb7-be61-310222b7****
AssetMemberUids	array	No	The list of member accounts for the asset address book.
	integer	No	The list of member accounts.	13580xxxxxx6271

Response elements

Element	Type	Description	Example
	object
PageNo	string	The page number of the current page.	1
PageSize	string	The number of address books on each 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 address book information.
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 the public IP addresses of ECS instances that match new tags are automatically added to the address book. Valid values: 0: The public IP addresses are not automatically added. 1: The public IP addresses are automatically added. Valid values: 0 : Not automatically added. 1 : Automatically added.	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-based public network address book. threat : threat intelligence address book. tagPrivate : ECS label-based private endpoint address book. backsrcIpv6 : IPv6 back-to-origin address book. ackLabel : ACK pod label address book. cloudServiceDomain : cloud service domain name address book. cloud : cloud address book. backsrc : IPv4 back-to-origin address book. cloudDomain : cloud domain name address book. domain : domain name address book. assetIpv6 : IPv6 public assets address book. ackNamespace : ACK namespace address book. asset : IPv4 public assets address book.	ip
TagRelation	string	The relationship between multiple ECS tags. Valid values: or: The relationship between multiple tags is OR. The public IP address of an ECS instance that matches any tag is added to the address book. and: The relationship between multiple tags is AND. The public IP address of an ECS instance that matches all tags is added to the address book. Valid values: or : The relationship between multiple labels is OR. The public IP addresses of Elastic Compute Service (ECS) instances that match any label are added to the address book. and : The relationship between multiple labels is AND. Only the public IP addresses of Elastic Compute Service (ECS) instances that match all labels are added to the address book.	and
TagList	array<object>	The list of ECS tags.
	object	The ECS tag.
TagValue	string	The ECS tag value.	ALL VALUE
TagKey	string	The ECS tag key.	company
AddressList	array	The address list of the address book.
	string	The address information of the address book.	[ "192.168.XX.XX/32", "192.168.XX.XX/32" ]
Addresses	array<object>	The address list of the address book that includes descriptions for individual addresses.
	object	The address with a description in the address book.
Address	string	The address information of the address book.	192.168.0.1/32
Note	string	The description of the individual address.	Single Address Description
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	The pod label in the ACK cluster.
Key	string	The key of the ACK cluster pod label.	app
Value	string	The value of the ACK cluster pod label.	storage-operator
AckNamespaces	array	The list of pod namespaces in the ACK cluster.
	string	The pod namespace in the ACK cluster.	default
RegionNo	string	The region of the ACK cluster connector to which the address book belongs when GroupType is an ACK address book.	cn-beijing
AssetMemberUids	array	The list of member accounts for the asset address book.
	integer	The list of member accounts.	13580xxxxxx6271
AssetRegionResourceTypes	array<object>	The list of regions and resource types for the asset address book.
	array<object>	The region and resource type list.
AssetRegionId	string	The asset region ID. Valid values: all : All regions.	all
ResourceType	object	The asset type.
Ipv4	object	The IPv4 asset type.
SlbEIP	boolean	The asset type: SlbEIP. Valid values: true : Enabled. false : Disabled.	true
NatPublicIP	boolean	The asset type: NatPublicIP. Valid values: true : Enabled. false : Disabled.	false
BastionHostIngressIP	boolean	The asset type: BastionHostIngressIP. Valid values: true : Enabled. false : Disabled.	false
EniEIP	boolean	The asset type: EniEIP. Valid values: true : Enabled. false : Disabled.	false
NlbEIP	boolean	The asset type: NlbEIP. Valid values: true : Enabled. false : Disabled.	false
ApiGatewayEIP	boolean	The asset type: ApigEIP. Valid values: true : Enabled. false : Disabled.	false
EcsPublicIP	boolean	The asset type: EcsPublicIP. Valid values: true : Enabled. false : Disabled.	false
BastionHostIP	boolean	The asset type: BastionHostIP. Valid values: true : Enabled. false : Disabled.	false
BastionHostEgressIP	boolean	The asset type: BastionHostEgressIP. Valid values: true : Enabled. false : Disabled.	false
AlbEIP	boolean	The asset type: AlbEIP. Valid values: true : Enabled. false : Disabled.	false
GaEIP	boolean	The asset type: GaEIP. Valid values: true : Enabled. false : Disabled.	false
AiGatewayEIP	boolean	The asset type: AIGatewayEIP. Valid values: true : Enabled. false : Disabled.	false
EIP	boolean	The asset type: EIP. Valid values: true : Enabled. false : Disabled.	false
NatEIP	boolean	The asset type: NatEIP. Valid values: true : Enabled. false : Disabled.	false
SlbPublicIP	boolean	The asset type: SlbPublicIP. Valid values: true : Enabled. false : Disabled.	false
EcsEIP	boolean	The asset type: EcsEIP. Valid values: true : Enabled. false : Disabled.	false
HAVIP	boolean	The asset type: HAVIP. Valid values: true : Enabled. false : Disabled.	false
Ipv6	object	The IPv6 asset type.
SlbIPv6	boolean	The asset type: SlbIPv6. Valid values: true : Enabled. false : Disabled.	false
NlbIPv6	boolean	The asset type: NlbIPv6. Valid values: true : Enabled. false : Disabled.	false
EniEIPv6	boolean	The asset type: EniEIPv6. Valid values: true : Enabled. false : Disabled.	false
AlbIPv6	boolean	The asset type: AlbIPv6. Valid values: true : Enabled. false : Disabled.	false
GaEIPv6	boolean	The asset type: GaEIPv6. Valid values: true : Enabled. false : Disabled.	false
AiGatewayEIPv6	boolean	The asset type: AIGatewayEIPv6. Valid values: true : Enabled. false : Disabled.	false
EcsIPv6	boolean	The asset type: EcsIPv6. Valid values: true : Enabled. false : Disabled.	false
ApiGatewayEIPv6	boolean	The asset type: ApigEIPv6. Valid values: true : Enabled. false : Disabled.	false

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": "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",
      "AssetMemberUids": [
        0
      ],
      "AssetRegionResourceTypes": [
        {
          "AssetRegionId": "all",
          "ResourceType": {
            "Ipv4": {
              "SlbEIP": true,
              "NatPublicIP": false,
              "BastionHostIngressIP": false,
              "EniEIP": false,
              "NlbEIP": false,
              "ApiGatewayEIP": false,
              "EcsPublicIP": false,
              "BastionHostIP": false,
              "BastionHostEgressIP": false,
              "AlbEIP": false,
              "GaEIP": false,
              "AiGatewayEIP": false,
              "EIP": false,
              "NatEIP": false,
              "SlbPublicIP": false,
              "EcsEIP": false,
              "HAVIP": false
            },
            "Ipv6": {
              "SlbIPv6": false,
              "NlbIPv6": false,
              "EniEIPv6": false,
              "AlbIPv6": false,
              "GaEIPv6": false,
              "AiGatewayEIPv6": false,
              "EcsIPv6": false,
              "ApiGatewayEIPv6": false
            }
          }
        }
      ]
    }
  ]
}

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.