Queries the details about an address book for an access control policy.
Usage notes
You can call the DescribeAddressBook operation to query the details about an address book for an access control policy.
Limits
You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeAddressBook |
The operation that you want to perform. Set the value to DescribeAddressBook. |
SourceIp | String | No | 192.0.XX.XX |
The source IP address of the request. |
Lang | String | No | zh |
The language of the content within the request and response. Valid values:
|
CurrentPage | String | No | 1 |
The number of the page to return. Pages start from page 1. Default value: 1. |
PageSize | String | No | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 50. |
Query | String | No | 192.0.XX.XX |
The query condition that is used to search for the address book. |
GroupType | String | No | ip |
The type of the address book. Valid values:
Note If you do not specify a type, the domain address books and ECS tag-based address books
are queried.
|
ContainPort | String | No | 80 |
The port that is included in the address book. This parameter takes effect only when the GroupType parameter is set to port. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
PageNo | String | 1 |
The page number of the current page. |
PageSize | String | 10 |
The number of entries returned per page. |
RequestId | String | B36F150A-1E27-43AA-B72C-D2AC712F09DA |
The ID of the request. |
TotalCount | String | 100 |
The total number of the returned address books. |
Acls | Array of Acl |
The information about the address book. |
|
AddressListCount | Integer | 2 |
The number of addresses in the address book. |
GroupUuid | String | f04ac7ce-628b-4cb7-be61-310222b7**** |
The ID of the address book. |
AutoAddTagEcs | Integer | 1 |
Indicates whether the public IP addresses of ECS instances are automatically added to the address book if the instances match the specified tags. The setting takes effect on both newly purchased ECS instances whose tag settings are complete and ECS instances whose tag settings are modified. Valid values:
|
Description | String | DEMO address book |
The description of the address book. |
GroupName | String | demo_address_book |
The name of the address book. |
ReferenceCount | Integer | 3 |
The number of times that the address book is referenced. |
GroupType | String | ip |
The type of the address book. Valid values:
|
TagRelation | String | and |
The logical relationship among ECS tags. Valid values:
|
TagList | Array of TagListItem |
The details about the ECS tags that can be automatically added to the address book. |
|
TagValue | String | All values |
The value of the ECS tag. |
TagKey | String | company |
The key of the ECS tag. |
AddressList | Array of String | [ "192.168.XX.XX/32", "192.168.XX.XX/32" ] |
The addresses in the address book. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeAddressBook
&SourceIp=192.0.XX.XX
&Lang=zh
&CurrentPage=1
&PageSize=10
&Query=192.0.XX.XX
&GroupType=ip
&ContainPort=80
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeAddressBookResponse>
<PageNo>1</PageNo>
<PageSize>10</PageSize>
<RequestId>B36F150A-1E27-43AA-B72C-D2AC712F09DA</RequestId>
<TotalCount>100</TotalCount>
<Acls>
<AddressListCount>2</AddressListCount>
<GroupUuid>f04ac7ce-628b-4cb7-be61-310222b7****</GroupUuid>
<AutoAddTagEcs>1</AutoAddTagEcs>
<Description>DEMO address book</Description>
<GroupName>demo_address_book</GroupName>
<ReferenceCount>3</ReferenceCount>
<GroupType>ip</GroupType>
<TagRelation>and</TagRelation>
<TagList>
<TagValue> All values</TagValue>
<TagKey>company</TagKey>
</TagList>
<AddressList>[ "192.168.XX.XX/32", "192.168.XX.XX/32" ]</AddressList>
</Acls>
</DescribeAddressBookResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"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 address book",
"GroupName" : "demo_address_book",
"ReferenceCount" : 3,
"GroupType" : "ip",
"TagRelation" : "and",
"TagList" : [ {
"TagValue" : "All values",
"TagKey" : "company"
} ],
"AddressList" : [ "[ \"192.168.XX.XX/32\", \"192.168.XX.XX/32\" ]" ]
} ]
}