すべてのプロダクト
Search

このプロダクト

    Cloud Firewall:DescribeAddressBook

    ドキュメントセンター

    Cloud Firewall:DescribeAddressBook

    最終更新日:Jul 07, 2026

    アドレス帳を一括で照会します。

    操作説明

    この操作は、アクセスコントロールポリシーのアドレス帳の詳細をクエリするために使用されます。

    QPS 制限

    この操作の単一ユーザー QPS 制限は、1 秒あたり 10 回の呼び出しです。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。この操作は適切な周波数で呼び出してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    yundun-cloudfirewall:DescribeAddressBook

    get

    *AddressBook。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Lang

    string

    任意

    アドレス帳の説明の言語タイプ。有効な値:

    • en: 英語。

    • zh: 中国語 (デフォルト)。

    列挙値:

    • en :

      英語。

    • zh :

      中国語 (デフォルト)

    zh
    CurrentPage

    string

    任意

    ページングクエリのページ番号。

    デフォルト値: 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 Pod ラベルアドレス帳。

    • 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 インスタンスのパブリック IP アドレスがアドレス帳に自動的に追加されるかどうかを示します。有効な値:

    • 0: パブリック IP アドレスは自動的に追加されません。

    • 1: パブリック 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 Pod ラベルアドレス帳。

    • cloudServiceDomain :

      クラウドサービスドメイン名アドレス帳。

    • cloud :

      クラウドアドレス帳。

    • backsrc :

      IPv4 バックツーオリジンアドレス帳。

    • cloudDomain :

      クラウウドメイン名アドレス帳。

    • domain :

      ドメイン名アドレス帳。

    • assetIpv6 :

      IPv6 パブリックアセットアドレス帳。

    • ackNamespace :

      ACK 名前空間アドレス帳。

    • asset :

      IPv4 パブリックアセットアドレス帳。

    ip
    TagRelation

    string

    複数の ECS タグ間の関係。有効な値:

    • or: 複数のタグ間の関係は OR です。いずれかのタグに一致する ECS インスタンスのパブリック IP アドレスがアドレス帳に追加されます。

    • and: 複数のタグ間の関係は AND です。すべてのタグに一致する ECS インスタンスのパブリック IP アドレスがアドレス帳に追加されます。

    列挙値:

    • or :

      複数のラベル間の関係は OR です。いずれかのラベルに一致する Elastic Compute Service (ECS) インスタンスのパブリック IP アドレスがアドレス帳に追加されます。

    • and :

      複数のラベル間の関係は AND です。すべてのラベルに一致する Elastic Compute Service (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 クラスター内の Pod ラベルのリスト。

    object

    ACK クラスター内の Pod ラベル。

    Key

    string

    ACK クラスター Pod ラベルのキー。

    app
    Value

    string

    ACK クラスター Pod ラベルの値。

    storage-operator
    AckNamespaces

    array

    ACK クラスター内の Pod 名前空間のリスト。

    string

    ACK クラスター内の Pod 名前空間。

    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

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。