Queries the details of an address book for an access control policy.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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 1.2.3.4

The source IP address of the request.

Lang String No zh

The natural language of the request and response. Valid values:

  • zh: Chinese
  • en: English
CurrentPage String No 1

The page number of the current page. Default value: 1.

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 is used to search for the address book.

GroupType String No ip

The type of the address book. Valid values:

  • ip: IP address book
  • domain: domain address book
  • port: port address book
  • tag: Elastic Compute Service (ECS) tag-based address book
ContainPort String No 80

Details of the address book that includes specified ports. This parameter takes effect only when the GroupType parameter is set to port.

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 to automatically add public IP addresses of ECS instances to the address book if the instances match the specified tags. Valid values:

  • 1: yes
  • 0: no
Description String DEMO address book

The description of the address book.

Global Integer 0

Indicates whether the address book is global. Valid values:

  • 1: yes
  • 0: no
GroupName String demo_address_book

The name of the address book.

GroupType String ip

The type of the address book. Valid values:

  • ip: IP address book
  • domain: domain address book
  • port: port address book
  • tag: ECS tag-based address book
GroupUuid String f04ac7ce-628b-4cb7-be61-310222b718e8

The ID of the address book.

ReferenceCount Integer 3

The number of times that the address book is referenced.

TagList Array

Details about the ECS tags that can be automatically added 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. Valid values:

  • and: Only the public IP addresses of ECS instances that match all the specified tags can be added to the address book.
  • or: The public IP addresses of ECS instances that match one of the specified tags can be added to the address book.
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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAddressBook
&<Common request parameters>

Sample success responses

XML format

<DescribeAddressBookResponse>
      <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>
</DescribeAddressBookResponse>

JSON format

{
    "TotalCount":123,
    "PageSiNo": 1,
    "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
        }
    ]
}