All Products
Search
Document Center

Web Application Firewall:DescribeAddresses

Last Updated:Dec 26, 2025

Queries a paginated list of addresses in an address book.

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

InstanceId

string

Yes

The ID of the WAF instance.

Note

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. Set this parameter to perform a fuzzy query for added addresses.

1.2.3.3

NextToken

string

No

The token that is used to start the next page of results. Set this parameter to the value of NextToken that is returned from the previous call. Do not specify this parameter for the first call.

AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS

MaxResults

integer

No

The number of entries to return on each page. Valid values: 1 to 500. Default value: 20.

20

RegionId

string

No

The region where the WAF instance resides. Valid values:

  • cn-hangzhou: the Chinese mainland.

  • ap-southeast-1: outside the Chinese mainland.

cn-hangzhou

ResourceManagerResourceGroupId

string

No

The ID of the Alibaba Cloud resource group.

rg-acfm4gh****wela

Response elements

Element

Type

Description

Example

object

TotalCount

integer

The total number of returned entries.

10

RequestId

string

The ID of the request.

8D8EBFB7-E1EB-5236-952A-092EDC72***

AddressList

array<object>

The list of addresses.

object

The address information.

Address

string

A single address.

1.1.1.1

RuleId

integer

The ID of the address book.

12345678

GmtModified

integer

The most recent modification time of the address. This value is a UNIX timestamp. Unit: milliseconds.

1760408233000

NextToken

string

The token to start the next page of results. A return value for this parameter indicates that not all results have been returned.

Note

To retrieve the next page of results, include this value in the next request. If this parameter is not returned, all results have been retrieved.

AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS

MaxResults

integer

The number of entries returned per page. 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.