All Products
Search

This Product

    Cloud Firewall:DescribeAddressBook

    Document Center

    Cloud Firewall:DescribeAddressBook

    Last Updated:Mar 19, 2024

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

    Operation description

    You can call this 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

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    yundun-cloudfirewall:DescribeAddressBookRead
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    LangstringNo

    The language of the content within the request. Valid values:

    • zh (default): Chinese
    • en: English
    		zh
    CurrentPagestringNo

    The page number.

    Pages start from page 1. Default value: 1.

    		1
    PageSizestringNo

    The number of entries per page.

    Default value: 10. Maximum value: 50.

    		10
    QuerystringNo

    The query condition that is used to search for the address book.

    		192.0.XX.XX
    GroupTypestringNo

    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
    • allCloud: cloud service address book
    • threat: threat intelligence address book
    Note If you do not specify a type, the domain address books and ECS tag-based address books are queried.
    		ip
    ContainPortstringNo

    The port that is included in the address book. This parameter takes effect only when the GroupType parameter is set to port.

    		80

    Response parameters

    ParameterTypeDescriptionExample
    object
    PageNostring

    The page number.

    		1
    PageSizestring

    The number of entries per page.

    		10
    RequestIdstring

    The request ID.

    		B36F150A-1E27-43AA-B72C-D2AC712F09DA
    TotalCountstring

    The total number of the returned address books.

    		100
    Aclsobject []

    The information about the address book.

    AddressListCountinteger

    The number of addresses in the address book.

    		2
    GroupUuidstring

    The UUID of the address book.

    		f04ac7ce-628b-4cb7-be61-310222b7****
    AutoAddTagEcsinteger

    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:

    • 1: yes
    • 0: no
    		1
    Descriptionstring

    The description of the address book.

    		my address book
    GroupNamestring

    The name of the address book.

    		demo_address_book
    ReferenceCountinteger

    The number of times that the address book is referenced.

    		3
    GroupTypestring

    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
    • allCloud: cloud service address book
    • threat: threat intelligence address book
    		ip
    TagRelationstring

    The logical relationship 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 any of the specified tags can be added to the address book.
    		and
    TagListobject []

    The details about the ECS tags that can be automatically added to the address book.

    TagValuestring

    The value of the ECS tag.

    		admin
    TagKeystring

    The key of the ECS tag.

    		company
    AddressListarray

    The addresses in the address book.

    string

    The address in the address book.

    		192.168.XX.XX/32

    Examples

    Sample success responses

    JSONformat

    {
  "PageNo": "1",
  "PageSize": "10",
  "RequestId": "B36F150A-1E27-43AA-B72C-D2AC712F09DA",
  "TotalCount": "100",
  "Acls": [
    {
      "AddressListCount": 2,
      "GroupUuid": "f04ac7ce-628b-4cb7-be61-310222b7****",
      "AutoAddTagEcs": 1,
      "Description": "my address book",
      "GroupName": "demo_address_book",
      "ReferenceCount": 3,
      "GroupType": "ip",
      "TagRelation": "and",
      "TagList": [
        {
          "TagValue": "admin",
          "TagKey": "company"
        }
      ],
      "AddressList": [
        "192.168.XX.XX/32"
      ]
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ErrorParametersGroupTypeThe group type is invalid.The group type is invalid.
    400ErrorParametersUidThe aliUid parameter is invalid.The aliUid parameter is invalid.
    400ErrorParametersPageSizeOrNoEither pageSize or pageNo is invalid.Either pageSize or pageNo is invalid.
    400ErrorDBSelectAn error occurred while querying database.An error occurred while querying database.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-11-21The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2022-06-02The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400