Retrieve Paginated WAF Address Lists via DescribeAddresses API - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Queries addresses in an address book by paging.

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-waf:DescribeAddresses

list

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call DescribeInstance to query the ID of the current WAF instance.	waf_elasticity-cn-0xldbqt****
RuleId	integer	No	The ID of the address book to query.	12345678
AddressLike	string	No	The address to query. You can set this parameter to perform a fuzzy match on added addresses.	1.2.3.3
NextToken	string	No	The pagination token for the next page. Set this parameter to the value of NextToken returned in the previous API call. Leave this parameter empty for the first page.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	No	The number of entries per page for paging. Valid values: 1 to 500. Default value: 20.	20
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The Alibaba Cloud resource group ID.	rg-acfm4gh****wela

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	10
RequestId	string	The request ID.	8D8EBFB7-E1EB-5236-952A-092EDC72***
AddressList	array<object>	The list of addresses.
	object	The address information.
Address	string	The address.	1.1.1.1
RuleId	integer	The address book ID.	12345678
GmtModified	integer	The most recent modification time of the address. The value is a UNIX timestamp in milliseconds.	1760408233000
NextToken	string	The pagination token for the next page. If a next page exists, this field contains a value. Note If this parameter has a return value, a next page exists. You can pass the returned NextToken as a request parameter to retrieve the next page of data. Repeat this process until no value is returned, which indicates that all data has been retrieved.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	The number of entries per page for paging. Valid values: 1 to 500. Default value: 20.	20

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "8D8EBFB7-E1EB-5236-952A-092EDC72***",
  "AddressList": [
    {
      "Address": "1.1.1.1",
      "RuleId": 12345678,
      "GmtModified": 1760408233000
    }
  ],
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.