すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud DNS:DescribeCloudGtmAddressPool

    ドキュメントセンター

    Alibaba Cloud DNS:DescribeCloudGtmAddressPool

    最終更新日:Sep 09, 2025

    指定したアドレスプールの構成を取得します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    alidns:DescribeCloudGtmAddressPool

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AcceptLanguage

    string

    任意

    レスポンスの言語。有効な値：

    • zh-CN：中国語。

    • en-US（デフォルト）：英語。

    zh-CN
    ClientToken

    string

    任意

    クライアントが生成したトークンで、リクエストのべき等性を保証します。注意：トークンが異なるリクエスト間で一意であることを確認してください。トークンには最大 64 文字の ASCII 文字を含めることができます。

    1ae05db4-10e7-11ef-b126-00163e24****
    AddressPoolId

    string

    任意

    アドレスプールの一意の ID。

    pool-89564674533755****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの一意の ID。

    6856BCF6-11D6-4D7E-AC53-FD579933522B
    CreateTime

    string

    アドレスプールが作成された日時。

    2024-03-15T01:46Z
    CreateTimestamp

    integer

    アドレスプールが作成された日時を示すタイムスタンプ。

    1527690629357
    UpdateTime

    string

    アドレスプールが最後に変更された日時。

    2024-03-15T01:46Z
    UpdateTimestamp

    integer

    アドレスプールが最後に変更された日時を示すタイムスタンプ。

    1527690629357
    AddressPoolId

    string

    アドレスプールの一意の ID。

    pool-89564674533755****
    AddressPoolName

    string

    アドレスプールの名前。

    AddressPool-1
    AddressPoolType

    string

    アドレスプールの種類。有効な値：

    • IPv4

    • IPv6

    • domain

    IPv4
    AddressLbStrategy

    string

    アドレスプール内のアドレスの負荷分散ポリシー。有効な値：

    • round_robin：任意のソースからの DNS リクエストに対して、すべてのアドレスが返されます。アドレスは各レスポンスでローテーションされます。

    • sequence：任意のソースからの DNS リクエストに対して、優先順位が最も高いアドレスが返されます。優先順位は `SerialNumber` によって決まり、値が小さいほど優先順位が高くなります。優先順位が最も高いアドレスが利用できない場合は、次に優先順位が高いアドレスが返されます。

    • weight：各アドレスに重みを設定できます。DNS リクエストは、指定された重み比に基づいて解決されます。

    • source_nearest：Global Traffic Manager（GTM）は、DNS リクエストのソースに基づいてアドレスを返します。これにより、ユーザーの近接性に基づくアクセスが実装されます。

    round_robin
    SequenceLbStrategyMode

    string

    負荷分散ポリシーが `sequence` に設定されている場合に、プライマリアドレスが再び利用可能になった場合のサービスリカバリモード。有効な値：

    • preemptive：システムは優先的に `SerialNumber` が小さいアドレスを使用します。

    • non_preemptive：システムは現在のアドレスを引き続き使用します。

    preemptive
    EnableStatus

    string

    アドレスプールのステータス。有効な値：

    • enable：有効

    • disable：無効

    enable
    HealthJudgement

    string

    アドレスプールのヘルスステータスを判断するために使用される条件。有効な値：

    • any_ok：少なくとも 1 つのアドレスが利用可能です。

    • p30_ok：アドレスの少なくとも 30% が利用可能です。

    • p50_ok：アドレスの少なくとも 50% が利用可能です。

    • p70_ok：アドレスの少なくとも 70% が利用可能です。

    • all_ok：すべてのアドレスが利用可能です。

    any_ok
    HealthStatus

    string

    アドレスプールのヘルスステータス。有効な値：

    • ok：アドレスプールは正常です。アドレスプール内のすべてのアドレスが利用可能です。

    • ok_alert：アドレスプールはアラート状態です。一部のアドレスは利用できませんが、アドレスプールは引き続き正常と見なされます。この状態では、利用可能なアドレスに対して DNS 解決が実行されますが、利用できないアドレスに対しては実行されません。

    • exceptional：アドレスプールは異常です。一部またはすべてのアドレスが利用できず、アドレスプールは異常と見なされます。

    ok
    AvailableStatus

    string

    アドレスプールの可用性ステータス。有効な値：

    • available：利用可能。

    • unavailable：利用不可。

    available
    Addresses

    object

    Address

    array<object>

    アドレスのリスト。

    object

    アドレスに関する情報。

    CreateTime

    string

    アドレスが作成された日時。

    2024-03-15T01:46Z

    CreateTimestamp

    integer

    アドレスが作成された日時を示すタイムスタンプ。

    1527690629357
    UpdateTime

    string

    アドレスが最後に変更された日時。

    2024-03-15T01:46Z

    UpdateTimestamp

    integer

    アドレスが最後に変更された日時を示すタイムスタンプ。

    1527690629357
    AddressId

    string

    アドレスの一意の ID。

    addr-89518218114368****
    WeightValue

    integer

    アドレスの重み。これは 1 から 100 までの整数です。各アドレスに重みを設定できます。DNS リクエストは、指定された重み比に基づいて解決されます。

    1
    SerialNumber

    integer

    アドレスのシリアル番号。この番号はアドレスの優先順位を示します。値が小さいほど優先順位が高くなります。

    1
    RequestSource

    object

    RequestSource

    array

    DNS リクエストソースのリスト。

    string

    DNS リクエストのソース。GTM は、クライアントが使用するローカル DNS（LDNS）サーバーの出力 IP アドレスに基づいてトラフィックをスケジュールします。LDNS サーバーが Extension Mechanisms for DNS（EDNS）クライアントサブネット（ECS）をサポートしている場合、GTM はクライアントの IP アドレスに基づいてトラフィックもスケジュールします。

    ["default"]
    Name

    string

    アドレスの名前。

    Address-1
    Type

    string

    アドレスの種類。有効な値：

    • IPv4：IPv4 アドレス

    • IPv6：IPv6 アドレス

    • domain：ドメイン名

    IPv4
    Address

    string

    IP アドレスまたはドメイン名。

    223.5.XX.XX
    AttributeInfo

    string

    アドレスのソース。このパラメータは現在のバージョンでは返されません。

    当前版本不支持返回此参数。
    Remark

    string

    アドレスに関するメモ。

    test
    EnableStatus

    string

    アドレスのステータス。アドレスが利用可能かどうかを示します。有効な値：

    • enable：有効

    • disable：無効

    enable
    AvailableMode

    string

    アドレスのヘルスチェックベースのフェールオーバーモード。有効な値：

    • auto：システムはヘルスチェックの結果に基づいてアドレスステータスを自動的に判断します。ヘルスチェックが失敗した場合、アドレスの DNS 解決は停止します。ヘルスチェックが成功した場合、アドレスの DNS 解決は再開されます。

    • manual：アドレスステータスを手動で制御します。アドレスが異常な状態の場合、アドレスの DNS 解決は停止し、ヘルスチェックが成功しても再開されません。アドレスが正常な状態の場合、アドレスの DNS 解決は再開されます。ヘルスチェックの失敗はアラートをトリガーするだけで、DNS 解決を停止しません。

    auto
    ManualAvailableStatus

    string

    フェールオーバーモードが `manual` の場合にアドレスに設定される可用性ステータス。有効な値：

    • available：アドレスは利用可能です。アドレスに対して DNS 解決が実行されます。ヘルスチェックの失敗はアラートをトリガーするだけで、DNS 解決を停止しません。

    • unavailable：アドレスは利用できません。アドレスの DNS 解決は停止し、ヘルスチェックが成功しても再開されません。

    available
    AvailableStatus

    string

    アドレスの可用性ステータス。有効な値：

    • available：利用可能。

    • unavailable：利用不可。

    available
    HealthStatus

    string

    アドレスのヘルスチェックステータス。有効な値：

    • ok：関連付けられているヘルスチェックテンプレートのすべてのヘルスチェックタスクは正常です。

    • ok_alert：関連付けられているヘルスチェックテンプレートのヘルスチェックタスクの一部が異常ですが、アドレスは引き続き正常と見なされます。

    • ok_no_monitor：アドレスはヘルスチェックテンプレートに関連付けられておらず、ステータスは正常です。

    • exceptional：関連付けられているヘルスチェックテンプレートのヘルスチェックタスクの一部またはすべてが異常であり、アドレスは異常と見なされます。

    ok
    HealthJudgement

    string

    アドレスのヘルスステータスを判断するために使用される条件。有効な値：

    • any_ok：少なくとも 1 つのヘルスチェックが成功しています。

    • p30_ok：ヘルスチェックの少なくとも 30% が成功しています。

    • p50_ok：ヘルスチェックの少なくとも 50% が成功しています。

    • p70_ok：ヘルスチェックの少なくとも 70% が成功しています。

    • all_ok：すべてのヘルスチェックが成功しています。

    any_ok
    HealthTasks

    object

    HealthTask

    array<object>

    ヘルスチェックタスクのリスト。

    object

    ヘルスチェックタスクの構成。

    Port

    integer

    チェック対象のアドレスのサービスポート。ヘルスチェックプロトコルが `ping` の場合、このパラメータはサポートされていません。

    80
    TemplateId

    string

    アドレスに関連付けられているヘルスチェックテンプレートの ID。

    mtp-89518052425100**80

    TemplateName

    string

    ヘルスチェックテンプレートの名前。

    IPv4-Ping
    SeqNonPreemptiveSchedule

    boolean

    アドレスが順次（非プリエンプティブ）モードのスケジューリングオブジェクトであるかどうかを示します。これは、ハイブリッドクラウド管理シナリオに適用されます。有効な値：

    • true

    • false

    false
    Remark

    string

    アドレスに関するメモ。

    test

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "CreateTime": "2024-03-15T01:46Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-15T01:46Z",
  "UpdateTimestamp": 1527690629357,
  "AddressPoolId": "pool-89564674533755****",
  "AddressPoolName": "AddressPool-1",
  "AddressPoolType": "IPv4",
  "AddressLbStrategy": "round_robin",
  "SequenceLbStrategyMode": "preemptive",
  "EnableStatus": "enable",
  "HealthJudgement": "any_ok",
  "HealthStatus": "ok",
  "AvailableStatus": "available",
  "Addresses": {
    "Address": [
      {
        "CreateTime": "2024-03-15T01:46Z\n",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z\n",
        "UpdateTimestamp": 1527690629357,
        "AddressId": "addr-89518218114368****",
        "WeightValue": 1,
        "SerialNumber": 1,
        "RequestSource": {
          "RequestSource": [
            "[\"default\"]"
          ]
        },
        "Name": "Address-1",
        "Type": "IPv4",
        "Address": "223.5.XX.XX",
        "AttributeInfo": "当前版本不支持返回此参数。",
        "Remark": "test",
        "EnableStatus": "enable",
        "AvailableMode": "auto",
        "ManualAvailableStatus": "available",
        "AvailableStatus": "available",
        "HealthStatus": "ok",
        "HealthJudgement": "any_ok",
        "HealthTasks": {
          "HealthTask": [
            {
              "Port": 80,
              "TemplateId": "mtp-89518052425100**80\n",
              "TemplateName": "IPv4-Ping"
            }
          ]
        },
        "SeqNonPreemptiveSchedule": false
      }
    ]
  },
  "Remark": "test"
}

    エラーコード

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

    変更履歴

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