You can call this operation to query detailed information about access control address books.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeAddressBook |
The operation that you want to perform. Set the value to DescribeAddressBook. |
ContainPort | String | No | 80 |
The port that is contained in the address book. This parameter only takes effect when the GroupType parameter is set to port. |
CurrentPage | String | No | 1 |
The number of the page to return. Default value: 1. |
GroupType | String | No | ip |
The type of the address book. Valid values:
|
Lang | String | No | zh |
The language of the request and response. Valid values:
|
PageSize | String | No | 50 |
The number of entries to return on each page. Maximum value: 50. |
Query | String | No | 1.2.3.0 |
The query condition that specifies the address book. |
SourceIp | String | No | 1.2.3.4 |
The source IP address of the request. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Acls | Array |
The information about the address book. |
|
AddressList | List | [ "1.2.3.4/32", "0.0.0.0/0" ] |
The addresses in the address book. |
AddressListCount | Integer | 2 |
The number of addresses in the returned address book. |
AutoAddTagEcs | Integer | 1 |
Indicates whether ECS public IP addresses that match the specified tags are automatically added to the address book. Valid values:
|
Description | String | DEMO address book |
The description of the address book. |
Global | Integer | 0 |
Indicates whether the address book is global. Valid values:
|
GroupName | String | demo_address_book |
The name of the address book. |
GroupType | String | ip |
The type of the address book. Valid values:
|
GroupUuid | String | f04ac7ce-628b-4cb7-be61-310222b718e8 |
The unique ID of the returned address book. |
ReferenceCount | Integer | 3 |
The number of times that the address book is referenced. |
TagList | Array |
The tags that are used to add matching ECS public IP addresses to the address book. |
|
TagKey | String | key1 |
The key of the ECS tag. |
TagValue | String | value1 |
The value of the ECS tag. |
TagRelation | String | and |
The logical relation among ECS tags.
|
PageNo | String | 1 |
The page number of the returned page. |
PageSize | String | 10 |
The number of entries returned on each page. |
RequestId | String | B36F150A-1E27-43AA-B72C-D2AC712F09DA |
The ID of the request. |
TotalCount | String | 100 |
The total number of address books. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeAddressBook
&<Common request parameters>
Sample success responses
XML
format
<DescribeAddressBook>
<TotalCount>123</TotalCount>
<PageSiNo>1</PageSiNo>
<PageSize>1</PageSize>
<RequestId>B36F150A-1E27-43AA-B72C-D2AC712F09DA</RequestId>
<Acls>
<Description>9-3 IP address book</Description>
<GroupType>ip</GroupType>
<AddressList>1.2.3.4/32</AddressList>
<AddressList>0.0.0.0/0</AddressList>
<GroupName>9-3 IP address book</GroupName>
<AutoAddTagEcs>0</AutoAddTagEcs>
<TagValue></TagValue>
<TagRelation></TagRelation>
<ReferenceCount>0</ReferenceCount>
<TagKey></TagKey>
<AddressListCount>2</AddressListCount>
<GroupUuid>a3c5e-018e-4c08-bea8-eafc95d1a54e</GroupUuid>
<Global>0</Global>
</Acls>
</DescribeAddressBook>
JSON
format
{
"TotalCount":123,
"PageSize":1,
"RequestId":"B36F150A-1E27-43AA-B72C-D2AC712F09DA",
"Acls":[
{
"Description":"9-3 IP address book",
"GroupType":"ip",
"AddressList":[
"1.2.3.4/32",
"0.0.0.0/0"
],
"GroupName":"9-3 IP address book",
"AutoAddTagEcs":0,
"TagValue":"",
"TagRelation":"",
"TagList":[],
"ReferenceCount":0,
"TagKey":"",
"AddressListCount":2,
"GroupUuid":"a3c5e-018e-4c08-bea8-eafc95d1a54e",
"Global":0
}
],
"PageSiNo":1
}
Error codes
For a list of error codes, visit the API Error Center.