すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud DNS:DescribeCloudGtmAddressPoolReference

    ドキュメントセンター

    Alibaba Cloud DNS:DescribeCloudGtmAddressPoolReference

    最終更新日: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:DescribeCloudGtmAddressPoolReference

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AcceptLanguage

    string

    任意

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

    • zh-CN：中国語。

    • en-US：英語。これはデフォルト値です。

    en-US
    ClientToken

    string

    任意

    リクエストのべき等性を確保するために使用されるクライアントトークン。異なるリクエスト間で一意になるようにトークンを生成します。トークンには最大 64 文字の ASCII 文字を含めることができます。

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

    AddressPoolId

    string

    任意

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

    pool-89528023225442****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの一意の ID。

    853805EA-3D47-47D5-9A1A-A45C24313ABD
    AddressPoolId

    string

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

    pool-89528023225442****
    AddressPoolName

    string

    アドレスプールの名前。

    app
    InstanceConfigs

    object

    InstanceConfig

    array<object>

    アドレスプールを参照するインスタンスのリスト。

    object

    アドレスプールを参照するインスタンス。

    InstanceId

    string

    Global Traffic Manager (GTM) 3.0 インスタンスの ID。

    gtm-cn-jmp3qnw****
    ConfigId

    string

    ドメイン名インスタンスの構成 ID。同じアクセスドメイン名と GTM インスタンスに対して A レコードと AAAA レコードの両方を構成できます。この場合、GTM インスタンスに対して 2 つの構成が作成されます。ConfigId パラメータは、構成を一意に識別します。

    config-00****
    VersionCode

    string

    GTM 3.0 インスタンスのエディション。有効な値：

    • standard：Standard Edition

    • ultimate：Ultimate Edition

    ultimate
    InstanceName

    string

    インスタンスの名前。

    test
    ScheduleZoneName

    string

    GTM にアクセスするために使用されるプライマリドメイン名 (例：example.com) またはサブドメイン名 (例：a.example.com)。このドメイン名は通常、Alibaba Cloud DNS コンソールの権威ゾーンでホストされます。権威ゾーンは、GTM インスタンスと同じアカウントに属します。

    example.com
    ScheduleHostname

    string

    GTM にアクセスするために使用されるドメイン名のホストレコード。

    www
    ScheduleDomainName

    string

    GTM にアクセスするために使用されるドメイン名。ドメイン名は、ホストレコード (ScheduleHostname) とプライマリまたはサブドメイン名 (ScheduleZoneName) の組み合わせです。

    www.example.com
    ScheduleRrType

    string

    スケジューリングドメイン名の DNS レコードタイプ。有効な値：

    • A：IPv4 アドレス

    • AAAA：IPv6 アドレス

    • CNAME：CNAME ドメイン名

    A
    Ttl

    integer

    グローバル生存時間 (TTL)。これは、アクセスドメイン名をアドレスプール内のアドレスにマッピングする DNS レコードの TTL です。グローバル TTL は、DNS レコードがキャリアの再帰 DNS サーバーにキャッシュされる期間に影響します。カスタム TTL を指定できます。

    30
    AddressPoolLbStrategy

    string

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

    • round_robin：ポーリング。すべてのアドレスプールがすべての DNS リクエストに対して返されます。アドレスプールはリクエストごとにローテーションされます。

    • sequence：順次。序数が最も小さいアドレスプールが、すべての DNS リクエストに対して返されます。序数が小さいほど、優先順位が高いことを示します。優先順位が最も高いアドレスプールが使用できない場合、2 番目に優先順位が高いアドレスプールが返されます。

    • weight：加重。アドレスプールごとに異なる重みを設定できます。DNS リクエストは、重みに基づいてアドレスプールにルーティングされます。

    • source_nearest：ソース近接。これはインテリジェント DNS 解決機能です。GTM は、DNS リクエストのソースに基づいて異なるアドレスプールを返します。これにより、ユーザーは最も近い場所にアクセスできます。

    round_robin
    SequenceLbStrategyMode

    string

    負荷分散ポリシーが sequence で、優先順位の高いリソースが例外から回復した場合のサービス回復モード。有効な値：

    • preemptive：プリエンプティブモード。優先順位の高いアドレスプールが回復すると、トラフィックはすぐに切り替えられます。

    • non_preemptive：非プリエンプティブモード。優先順位の高いアドレスプールが回復しても、トラフィックは現在のアドレスプールのままです。

    preemptive
    AvailableStatus

    string

    ドメイン名インスタンスサービスの可用性ステータス。有効な値：

    • available：ドメイン名は有効で正常です。アクセスドメイン名のサービスは利用可能です。

    • unavailable：ドメイン名は無効または異常です。アクセスドメイン名のサービスは利用できません。

    available
    EnableStatus

    string

    ドメイン名インスタンスの有効化ステータス。有効な値：

    • enable：有効。GTM インスタンスのインテリジェントスケジューリングポリシーはアクティブです。

    • disable：無効。GTM インスタンスのインテリジェントスケジューリングポリシーは非アクティブです。

    enable
    HealthStatus

    string

    ドメイン名インスタンスのヘルスステータス。有効な値：

    • ok：正常。アクセスドメイン名によって参照されるすべてのアドレスプールが利用可能です。

    • ok_alert：警告。アクセスドメイン名によって参照されるアドレスプールの一部が使用できません。この状態では、DNS 解決は使用可能なアドレスプールに対して続行されますが、使用できないアドレスプールに対しては停止します。

    • exceptional：異常。アクセスドメイン名によって参照されるすべてのアドレスプールが使用できません。この場合、序数が最も小さい空でないアドレスプールのアドレスを使用して、フェールオーバー解決が実行されます。これにより、クライアントは DNS 応答を受信できます。

    ok
    Remark

    string

    備考。

    test

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "853805EA-3D47-47D5-9A1A-A45C24313ABD",
  "AddressPoolId": "pool-89528023225442****",
  "AddressPoolName": "app",
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-jmp3qnw****",
        "ConfigId": "config-00****",
        "VersionCode": "ultimate",
        "InstanceName": "test",
        "ScheduleZoneName": "example.com",
        "ScheduleHostname": "www",
        "ScheduleDomainName": "www.example.com",
        "ScheduleRrType": "A",
        "Ttl": 30,
        "AddressPoolLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "AvailableStatus": "available",
        "EnableStatus": "enable",
        "HealthStatus": "ok",
        "Remark": "test"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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