全部產品
Search

搜尋本產品

    Cloud Firewall：DescribeAddressBook

    文件中心

    Cloud Firewall：DescribeAddressBook

    更新時間：Jul 07, 2026

    批次查詢地址簿清單。

    介面說明

    本介面一般用於查詢存取控制策略地址簿的詳細資訊。

    QPS 限制

    本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理呼叫。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-cloudfirewall:DescribeAddressBook

    get

    *AddressBook

    acs:cloudfirewall::{#accountId}:addressbook/{#GroupUuid}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Lang

    string

    否

    地址簿描述的語言類型。

    枚舉值：

    • en :

      英文。

    • zh :

      中文（預設）

    zh
    CurrentPage

    string

    否

    分頁查詢時，設定目前頁面的頁碼。

    預設值為 1，表示返回第 1 頁資料。

    1
    PageSize

    string

    否

    分頁查詢時，設定每頁包含的地址簿數量。

    預設值為 10，表示每頁包含 10 筆結果。最大值為 50。

    10
    Query

    string

    否

    搜尋條件，輸入待查詢地址簿資訊。

    192.0.XX.XX
    GroupType

    string

    否

    地址簿的類型。

    說明

    不設定該參數表示查詢 IP 地址簿和 ECS 標籤地址簿。

    枚舉值：

    • allCloud :

      雲端服務通訊錄。

    • port :

      連接埠地址簿。

    • ipv6 :

      IPv6 地址簿。

    • ip :

      IPv4 地址簿。

    • domain :

      網域地址簿。

    • ack :

      ACK 通訊錄。

    • tag :

      ECS 標籤公網地址簿。

    • threat :

      情報地址簿。

    • tagPrivate :

      ECS 標籤私有網路地址簿。

    • backsrcIpv6 :

      IPv6 回源地址簿。

    • ackLabel :

      ACK 容器群組標籤地址簿。

    • cloud :

      雲端地址簿。

    • cloudServiceDomain :

      雲端服務網域地址簿。

    • backsrc :

      IPv4 回源地址簿。

    • cloudDomain :

      雲端網域地址簿。

    • assetIpv6 :

      IPv6 公網資產地址簿。

    • ackNamespace :

      ACK 命名空間地址簿。

    • asset :

      IPv4 公網資產地址簿。

    ip
    ContainPort

    string

    否

    查詢包含指定連接埠的地址簿。僅當 GroupType 參數的值為 port 時，該參數才會作為本次查詢的條件。

    80
    GroupUuid

    string

    否

    地址簿的唯一識別 ID。

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

    array

    否

    資產地址簿，成員帳號清單。

    integer

    否

    成員帳號清單。

    13580xxxxxx6271

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    PageNo

    string

    目前頁面的頁碼。

    1
    PageSize

    string

    每頁包含的地址簿數量。

    10
    RequestId

    string

    結果的請求 ID。

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

    string

    地址簿的總數量。

    100
    Acls

    array<object>

    地址簿清單。

    array<object>

    地址簿資訊。

    AddressListCount

    integer

    地址簿中包含地址的個數。

    2
    GroupUuid

    string

    地址簿的唯一識別 ID。

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

    integer

    是否自動新增新匹配標籤的 ECS（新購且完成標籤設定的 ECS 或修改標籤的 ECS）公網 IP 到地址簿。

    枚舉值：

    • 0 :

      不自動新增。

    • 1 :

      自動新增。

    1
    Description

    string

    地址簿的描述資訊。

    DEMO
    GroupName

    string

    地址簿的名稱。

    demo_address_book
    ReferenceCount

    integer

    地址簿被引用次數。

    3
    GroupType

    string

    地址簿的類型。

    枚舉值：

    • allCloud :

      雲端服務通訊錄。

    • port :

      連接埠地址簿。

    • ipv6 :

      IPv6 地址簿。

    • ip :

      IPv4 地址簿。

    • ack :

      ACK 通訊錄。

    • tag :

      ECS 標籤公網地址簿。

    • threat :

      情報地址簿。

    • tagPrivate :

      ECS 標籤私有網路地址簿。

    • backsrcIpv6 :

      IPv6 回源地址簿。

    • ackLabel :

      ACK 容器群組標籤地址簿。

    • cloudServiceDomain :

      雲端服務網域地址簿。

    • cloud :

      雲端地址簿。

    • backsrc :

      IPv4 回源地址簿。

    • cloudDomain :

      雲端網域地址簿。

    • domain :

      網域地址簿。

    • assetIpv6 :

      IPv6 公網資產地址簿。

    • ackNamespace :

      ACK 命名空間地址簿。

    • asset :

      IPv4 公網資產地址簿。

    ip
    TagRelation

    string

    多個 ECS 標籤間的關係。

    枚舉值：

    • or :

      多個標籤間為「或」關係，即只要匹配一個標籤的 ECS 公網 IP 就會被加入地址簿。

    • and :

      多個標籤間為「與」關係，即同時匹配多個標籤的 ECS 公網 IP 才會被加入地址簿。

    and
    TagList

    array<object>

    ECS 標籤清單。

    object

    ECS 標籤。

    TagValue

    string

    ECS 標籤值。

    ALL VALUE
    TagKey

    string

    ECS 標籤鍵。

    company
    AddressList

    array

    地址簿的地址清單。

    string

    地址簿的地址資訊。

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

    array<object>

    地址簿含單地址描述的地址清單。

    object

    地址簿含單地址描述的地址。

    Address

    string

    通訊錄的地址資訊。

    192.168.0.1/32
    Note

    string

    單一地址描述。

    Single Address Description
    AckClusterConnectorId

    string

    ACK 叢集連接器 ID。

    ac-7c1bad6c3cc84c33baab
    AckClusterConnectorName

    string

    ACK 叢集連接器名稱。

    ack-cluster-connector-name
    AckLabels

    array<object>

    ACK 叢集容器群組標籤清單。

    object

    ACK 叢集容器群組標籤。

    Key

    string

    ACK 叢集容器群組標籤的鍵。

    app
    Value

    string

    ACK 叢集容器群組標籤的值。

    storage-operator
    AckNamespaces

    array

    ACK 叢集容器群組命名空間清單。

    string

    ACK 叢集容器群組命名空間。

    default
    RegionNo

    string

    當 GroupType 是 ACK 地址簿時，地址簿所屬的 ACK 叢集連接器的地域。

    cn-beijing
    AssetMemberUids

    array

    資產地址簿，成員帳號清單。

    integer

    成員帳號清單。

    13580xxxxxx6271
    AssetRegionResourceTypes

    array<object>

    資產地址簿，地域和資源類型清單。

    array<object>

    地域和資源類型清單。

    AssetRegionId

    string

    資產地域 ID。

    枚舉值：

    • all :

      全部地域。

    all
    ResourceType

    object

    資產類型。

    Ipv4

    object

    IPv4 資產類型。

    SlbEIP

    boolean

    資產類型：SlbEIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    true
    NatPublicIP

    boolean

    資產類型：NatPublicIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    BastionHostIngressIP

    boolean

    資產類型：BastionHostIngressIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    EniEIP

    boolean

    資產類型：EniEIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    NlbEIP

    boolean

    資產類型：NlbEIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    ApiGatewayEIP

    boolean

    資產類型：ApigEIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    EcsPublicIP

    boolean

    資產類型：EcsPublicIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    BastionHostIP

    boolean

    資產類型：BastionHostIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    BastionHostEgressIP

    boolean

    資產類型：BastionHostEgressIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    AlbEIP

    boolean

    資產類型：AlbEIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    GaEIP

    boolean

    資產類型：GaEIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    AiGatewayEIP

    boolean

    資產類型：AIGatewayEIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    EIP

    boolean

    資產類型：EIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    NatEIP

    boolean

    資產類型：NatEIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    SlbPublicIP

    boolean

    資產類型：SlbPublicIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    EcsEIP

    boolean

    資產類型：EcsEIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    HAVIP

    boolean

    資產類型：HAVIP。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    Ipv6

    object

    IPv6 資產類型。

    SlbIPv6

    boolean

    資產類型：SlbIPv6。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    NlbIPv6

    boolean

    資產類型：NlbIPv6。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    EniEIPv6

    boolean

    資產類型：EniEIPv6。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    AlbIPv6

    boolean

    資產類型：AlbIPv6。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    GaEIPv6

    boolean

    資產類型：GaEIPv6。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    AiGatewayEIPv6

    boolean

    資產類型：AIGatewayEIPv6。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    EcsIPv6

    boolean

    資產類型：EcsIPv6。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false
    ApiGatewayEIPv6

    boolean

    資產類型：ApigEIPv6。

    枚舉值：

    • true :

      開啟。

    • false :

      關閉。

    false

    樣本

    正常返回樣本

    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": "ALL VALUE",
          "TagKey": "company"
        }
      ],
      "AddressList": [
        "[ \"192.168.XX.XX/32\", \"192.168.XX.XX/32\" ]"
      ],
      "Addresses": [
        {
          "Address": "192.168.0.1/32",
          "Note": "Single Address Description"
        }
      ],
      "AckClusterConnectorId": "ac-7c1bad6c3cc84c33baab",
      "AckClusterConnectorName": "ack-cluster-connector-name",
      "AckLabels": [
        {
          "Key": "app",
          "Value": "storage-operator"
        }
      ],
      "AckNamespaces": [
        "default"
      ],
      "RegionNo": "cn-beijing",
      "AssetMemberUids": [
        0
      ],
      "AssetRegionResourceTypes": [
        {
          "AssetRegionId": "all",
          "ResourceType": {
            "Ipv4": {
              "SlbEIP": true,
              "NatPublicIP": false,
              "BastionHostIngressIP": false,
              "EniEIP": false,
              "NlbEIP": false,
              "ApiGatewayEIP": false,
              "EcsPublicIP": false,
              "BastionHostIP": false,
              "BastionHostEgressIP": false,
              "AlbEIP": false,
              "GaEIP": false,
              "AiGatewayEIP": false,
              "EIP": false,
              "NatEIP": false,
              "SlbPublicIP": false,
              "EcsEIP": false,
              "HAVIP": false
            },
            "Ipv6": {
              "SlbIPv6": false,
              "NlbIPv6": false,
              "EniEIPv6": false,
              "AlbIPv6": false,
              "GaEIPv6": false,
              "AiGatewayEIPv6": false,
              "EcsIPv6": false,
              "ApiGatewayEIPv6": false
            }
          }
        }
      ]
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 ErrorParametersGroupType The group type is invalid.
    400 ErrorParametersUid The aliUid parameter is invalid.
    400 ErrorParametersPageSizeOrNo Either pageSize or pageNo is invalid.
    400 ErrorDBSelect An error occurred while querying database.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。