全部产品
Search

搜索本产品

    云防火墙：DescribeAddressBook - 查询访问控制策略地址簿

    文档中心

    云防火墙：DescribeAddressBook - 查询访问控制策略地址簿

    更新时间：Dec 19, 2024

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

    接口说明

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

    QPS 限制

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

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    yundun-cloudfirewall:DescribeAddressBookget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    Langstring否

    请求消息的语言类型。取值：

    • zh（默认）：中文。
    • en：英文。
    		zh
    CurrentPagestring否

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

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

    		1
    PageSizestring否

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

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

    		10
    Querystring否

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

    		192.0.XX.XX
    GroupTypestring否

    地址簿的类型。取值：

    • ip：IP 地址簿。

    • domain：域名地址簿。

    • port：端口地址簿。

    • tag：ECS 标签地址簿。

    • allCloud：云服务地址簿。

    • threat：威胁情报地址簿。

    • ipv6：IPv6 地址簿。

    说明 不设置该参数表示查询 IP 地址簿和 ECS 标签地址簿。
    		ip
    ContainPortstring否

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

    		80

    返回参数

    名称类型描述示例值
    object
    PageNostring

    当前页面的页码。

    		1
    PageSizestring

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

    		10
    RequestIdstring

    结果的请求 ID。

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

    地址簿的总数量。

    		100
    Aclsarray<object>

    地址簿信息。

    Aclobject
    AddressListCountinteger

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

    		2
    GroupUuidstring

    地址簿的唯一标识 ID。

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

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

    • 1：表示自动添加。

    • 0：表示不自动添加。

    		1
    Descriptionstring

    地址簿的描述信息。

    		DEMO地址簿
    GroupNamestring

    地址簿的名称。

    		demo_address_book
    ReferenceCountinteger

    地址簿被引用次数。

    		3
    GroupTypestring

    地址簿的类型。取值：

    • ip：IP 地址簿。

    • domain：域名地址簿。

    • port：端口地址簿。

    • tag：ECS 标签地址簿。

    • allCloud：云服务地址簿。

    • threat：威胁情报地址簿。

    		ip
    TagRelationstring

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

    • and：多个标签间为“与”关系，即同时匹配多个标签的 ECS 公网 IP 才会被加入地址簿。

    • or：多个标签间为“或”关系，即只要匹配一个标签的 ECS 公网 IP 就会被加入地址簿。

    		and
    TagListarray<object>

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

    TagListItemobject
    TagValuestring

    待匹配的 ECS 标签值。

    		全部VALUE
    TagKeystring

    待匹配的 ECS 标签 Key。

    		company
    AddressListarray

    地址簿的地址列表。

    StringItemstring

    地址簿的地址列表信息。

    		[ "192.168.XX.XX/32", "192.168.XX.XX/32" ]

    示例

    正常返回示例

    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\" ]"
      ]
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    400ErrorParametersGroupTypeThe group type is invalid.无效的group类型
    400ErrorParametersUidThe aliUid parameter is invalid.aliUid 不合法
    400ErrorParametersPageSizeOrNoEither pageSize or pageNo is invalid.无效的pageSize或者pageNo
    400ErrorDBSelectAn error occurred while querying database.内部错误：数据库查询错误

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-08-29OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
    2023-11-21OpenAPI 错误码发生变更查看变更详情
    2022-06-02OpenAPI 错误码发生变更查看变更详情