Queries a paginated list of addresses in an address book.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The ID of the Web Application Firewall (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 use for a fuzzy match. If you specify this parameter, only addresses that contain the specified string are returned. |
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 |
| 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 addresses that match the query conditions. |
10 |
| RequestId |
string |
The request ID. |
8D8EBFB7-E1EB-5236-952A-092EDC72*** |
| AddressList |
array<object> |
The addresses in the address book. |
|
|
object |
The details of the address entry. |
||
| Address |
string |
The IP address or CIDR block in the address book. |
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 pagination token for the next page. If this parameter is returned, more results are available. Note
Include this value in the NextToken parameter of the next request to retrieve additional results. If this parameter is not returned, all results have been retrieved. |
AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS |
| MaxResults |
integer |
The number of entries returned per page. |
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.