调用DescribeAddressBook接口查询云防火墙访问控制策略地址簿的详细信息。

使用说明

本接口一般用于查询访问控制策略地址簿的详细信息。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAddressBook

系统规定参数。取值:DescribeAddressBook

SourceIp String 192.0.XX.XX

访问者源IP地址。

Lang String zh

请求和接收消息的语言类型。取值:

  • zh(默认):中文。
  • en:英文。
CurrentPage String 1

分页查询时,设置当前页面的页码。

默认值为1,表示返回第1页数据。

PageSize String 10

分页查询时,设置每页包含的地址簿的数量。

默认值为10,表示每页包含10条结果。最大值为50。

Query String 192.0.XX.XX

搜索条件,输入待查询地址簿信息。

GroupType String ip

地址簿的类型。取值:

  • ip:IP地址簿。
  • domain:域名地址簿。
  • port:端口地址簿。
  • tag:ECS标签地址簿。
说明 不设置该参数表示查询IP地址簿和ECS标签地址簿。
ContainPort String 80

查询包含指定端口的地址簿。仅当GroupType参数的值为port时,该参数才会作为本次查询的条件。

返回数据

名称 类型 示例值 描述
PageNo String 1

当前页面的页码。

PageSize String 10

每页包含的地址簿的数量。

RequestId String B36F150A-1E27-43AA-B72C-D2AC712F09DA

结果的请求ID。

TotalCount String 100

地址簿的总数量。

Acls Array of Acl

地址簿信息。

AddressListCount Integer 2

地址簿中包含地址的个数。

GroupUuid String f04ac7ce-628b-4cb7-be61-310222b7****

地址簿的唯一标识ID。

AutoAddTagEcs Integer 1

是否自动添加新匹配标签的ECS(新购且完成标签设置的ECS或修改标签的ECS)公网IP到地址簿。取值:

  • 1:表示自动添加。
  • 0:表示不自动添加。
Description String DEMO地址簿

地址簿的描述信息。

GroupName String demo_address_book

地址簿的名称。

ReferenceCount Integer 3

地址簿被引用次数。

GroupType String ip

地址簿的类型。取值:

  • ip:IP地址簿。
  • domain:域名地址簿。
  • port:端口地址簿。
  • tag:ECS标签地址簿。
TagRelation String and

多个ECS标签间的关系。取值:

  • and:多个标签间为“与”关系,即同时匹配多个标签的ECS公网IP才会被加入地址簿。
  • or:多个标签间为“或”关系,即只要匹配一个标签的ECS公网IP就会被加入地址簿。
TagList Array of TagListItem

地址簿支持自动添加的待匹配ECS标签信息。

TagValue String 全部VALUE

待匹配的ECS标签值。

TagKey String company

待匹配的ECS标签Key。

AddressList Array of String [ "192.168.XX.XX/32", "192.168.XX.XX/32" ]

地址簿的地址列表信息。

示例

请求示例

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
&公共请求参数

正常返回示例

XML格式

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地址簿</Description>
        <GroupName>demo_address_book</GroupName>
        <ReferenceCount>3</ReferenceCount>
        <GroupType>ip</GroupType>
        <TagRelation>and</TagRelation>
        <TagList>
            <TagValue>全部VALUE</TagValue>
            <TagKey>company</TagKey>
        </TagList>
        <AddressList>[ "192.168.XX.XX/32", "192.168.XX.XX/32" ]</AddressList>
    </Acls>
</DescribeAddressBookResponse>

JSON格式

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地址簿",
    "GroupName" : "demo_address_book",
    "ReferenceCount" : 3,
    "GroupType" : "ip",
    "TagRelation" : "and",
    "TagList" : [ {
      "TagValue" : "全部VALUE",
      "TagKey" : "company"
    } ],
    "AddressList" : [ "[ \"192.168.XX.XX/32\", \"192.168.XX.XX/32\" ]" ]
  } ]
}