すべてのプロダクト
Search
ドキュメントセンター

Alibaba Cloud DNS:ListCloudGtmInstanceConfigs

最終更新日:Apr 02, 2026

アクセス ドメイン名とアドレスプール情報を含むインスタンス構成のリストを取得します。

今すぐお試しください

この 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:ListCloudGtmInstanceConfigs

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

AcceptLanguage

string

任意

応答の言語。有効な値は次のとおりです:

  • zh-CN:中国語

  • en-US (デフォルト):英語

en-US

ClientToken

string

任意

リクエストのべき等性を保証するために使用されるクライアントトークン。各リクエストに対して一意のトークンを生成します。トークンには、最大 64 個の ASCII 文字を含めることができます。

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

PageNumber

integer

任意

ページ番号。値は 1 から始まります。デフォルト値:1

1

PageSize

integer

任意

ページングクエリで各ページに返されるエントリ数。最大値:100。デフォルト値:20

20

InstanceId

string

任意

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

gtm-cn-wwo3a3h****

ScheduleZoneName

string

任意

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

example.com

EnableStatus

string

任意

ドメイン名インスタンスのステータス:

  • enable:GTM インスタンスはインテリジェント スケジューリング ポリシーを使用します。

  • disable:GTM インスタンスのインテリジェント スケジューリング ポリシーは利用できません。

enable

Remark

string

任意

備考。

test

ScheduleDomainName

string

任意

GTM アクセス ドメイン名。ドメイン名は、ホストレコード (ScheduleHostname) とルートドメインまたはサブドメイン (ScheduleZoneName) の組み合わせです。

www.example.com

レスポンスフィールド

フィールド

説明

object

RequestId

string

一意のリクエスト ID。

536E9CAD-DB30-4647-AC87-AA5CC38C5382

PageNumber

integer

ページ番号。値は 1 から始まります。デフォルト値:1

1

PageSize

integer

1 ページあたりのエントリ数。最大値:100。デフォルト値:20。

20

TotalPages

integer

総ページ数。

1

TotalItems

integer

ドメイン名インスタンス構成の総数。

10

InstanceConfigs

object

InstanceConfig

array<object>

インスタンス構成のリスト。

array<object>

インスタンス構成。

InstanceId

string

GTM 3.0 インスタンスの ID。

gtm-cn-wwo3a3h****

ConfigId

string

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

Config-000****

CreateTime

string

インスタンス構成が作成された時刻。

2024-03-15T01:46Z

CreateTimestamp

integer

インスタンスが作成されたことを示す UNIX タイムスタンプ。

1527690629357

UpdateTime

string

インスタンス構成が最後に変更された時刻。

2024-03-15T01:46Z

UpdateTimestamp

integer

インスタンス構成が最後に変更されたことを示す UNIX タイムスタンプ。

1527690629357

VersionCode

string

GTM 3.0 インスタンスのバージョン:

  • standard: Standard Edition。

  • ultimate: Ultimate Edition。

ultimate

CommodityCode

string

商品コード:

  • dns_gtm_public_cn:中国サイト (aliyun.com) の商品コード。

  • dns_gtm_public_intl:国際サイト (alibabacloud.com) の商品コード。

dns_gtm_public_cn

ScheduleZoneMode

string

アクセス ドメイン名の割り当てモード:

  • custom:ホストレコードをカスタマイズし、GTM インスタンスと同じアカウントに属するルートドメインまたはサブドメインに関連付けて、アクセス ドメイン名を生成できます。

  • sys_assign:システムがデフォルトのアクセス ドメイン名を割り当てます。この機能はサポートされなくなりました。このモードを選択しないでください。

custom

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:ドメイン名

A

Ttl

integer

グローバル TTL (秒単位)。これは、アクセス ドメイン名をアドレスプール内のアドレスにマッピングする DNS レコードの TTL 値です。TTL は、キャリア管理のローカル DNS サーバ上の DNS レコードのキャッシュ存続時間に影響します。カスタム TTL を指定できます。

60

AddressPoolLbStrategy

string

アドレスプールの負荷分散ポリシー:

  • round_robin:任意のソースからの DNS リクエストに対して、すべてのアドレスプールが順番に返されます。アドレスプールのシーケンスは、各リクエストごとにローテーションされます。

  • sequence:任意のソースからの DNS リクエストに対して、最小のシリアル番号を持つアドレスプールが返されます。シリアル番号が小さいほど優先度が高くなります。最小のシリアル番号を持つアドレスプールが利用できない場合、次に小さいシリアル番号を持つアドレスプールが返されます。

  • weight:各アドレスプールに異なる重みを設定できます。DNS リクエストは、その重みに基づいてアドレスプールにスケジュールされます。

  • source_nearest:GTM は、DNS リクエストのソースに基づいてアドレスプールを返し、近接ベースのアクセスを実装します。

round_robin

SequenceLbStrategyMode

string

アドレスプールの負荷分散ポリシーがシーケンスに設定されている場合の、プライマリ リソースのサービス回復モード:

  • 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

AddressPools

object

AddressPool

array<object>

アドレスプールのリスト。

array<object>

アドレスプール構成。

CreateTime

string

アドレスプールの作成時刻。

2024-03-15T01:46Z

CreateTimestamp

integer

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

1527690629357

UpdateTime

string

アドレスプールの最終更新日時。

2024-03-15T01:46Z

UpdateTimestamp

integer

アドレスプールが最終更新された日時を表す UNIX タイムスタンプ。

1527690629357

AddressPoolId

string

アドレスプールの ID。これはアドレスプールの一意の識別子です。

pool-89528023225442****

WeightValue

integer

重み。1 から 100 までの整数です。アドレスプールごとに異なる重みを設定できます。DNS リクエストは、各アドレスプールの重みに基づいて振り分けられます。

1

SerialNumber

integer

シリアル番号。任意のソースからの DNS リクエストに対して、シリアル番号が最も小さいアドレスプールが返されます。シリアル番号が小さいほど、優先度が高いことを示します。

1

RequestSource

object

RequestSource

array

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

string

リクエストソース。GTM は、クライアントが使用するローカル DNS サーバの送信元 IP アドレスに基づいてトラフィックをスケジュールします。ローカル DNS サーバが Extension Mechanisms for DNS (EDNS) クライアントサブネット (ECS) をサポートしている場合、GTM はクライアント IP アドレスに基づいてインテリジェント スケジューリングを実行することもできます。

["default"]

AddressPoolName

string

アドレスプールの名前。

AddressPool-1

AddressPoolType

string

アドレスプールのタイプ:

  • IPv4

  • IPv6

  • ドメイン

IPv4

AddressLbStrategy

string

アドレスプール内のアドレスの負荷分散ポリシー:

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

  • sequence:任意のソースからの DNS リクエストに対して、最小のシリアル番号を持つアドレスが返されます。シリアル番号が小さいほど優先度が高くなります。最小のシリアル番号を持つアドレスが利用できない場合、次に小さいシリアル番号を持つアドレスが返されます。

  • weight:各アドレスに異なる重みを設定できます。DNS リクエストは、その重みに基づいてアドレスにスケジュールされます。

  • source_nearest:GTM は、DNS リクエストのソースに基づいてアドレスを返し、近接ベースのアクセスを実装します。

round_robin

SequenceLbStrategyMode

string

アドレスの負荷分散ポリシーがシーケンスに設定されている場合の、プライマリリソースのサービス回復モードです。

  • preemptive:プリエンプティブモード。プライマリアドレスが回復すると、トラフィックはより小さいシリアル番号を持つプライマリアドレスに切り替わります。

  • non_preemptive:非プリエンプティブモード。プライマリアドレスが回復しても、トラフィックは現在のアドレスに留まります。

preemptive

EnableStatus

string

アドレスプールのステータス:

  • enable:有効

  • disable:無効

enable

HealthJudgement

string

アドレスプールのヘルスステータス:

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

  • ok_alert:警告。アドレスプール内の一部の​​アドレスは利用できませんが、アドレスプールは依然として正常と見なされます。この状態では、DNS リクエストは利用可能なアドレスに解決され、利用できないアドレスは使用されません。

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

ok

HealthStatus

string

アドレスプールの健全性ステータスは次のとおりです。

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

  • ok_alert: 警告。アドレスプール内の一部のIPアドレスは利用できませんが、アドレスプール自体は正常と見なされます。この状態では、DNS リクエストは利用可能なアドレスに解決され、利用できないアドレスは使用されません。

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

ok

AvailableStatus

string

アドレスプールの可用性ステータス:

  • available:利用可能

  • unavailable:利用不可

available

SeqNonPreemptiveSchedule

boolean

アドレスが非プリエンプティブ シーケンシャル モードのスケジューリング オブジェクトであるかどうかを示します。このパラメータは、ハイブリッドクラウド管理シナリオで使用されます。

  • true:はい

  • false:いいえ

false

ConfigLoggingSwitchStatus

string

ENABLE

成功レスポンス

JSONJSON

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 10,
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-wwo3a3h****",
        "ConfigId": "Config-000****\n",
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z\n",
        "UpdateTimestamp": 1527690629357,
        "VersionCode": "ultimate",
        "CommodityCode": "dns_gtm_public_cn",
        "ScheduleZoneMode": "custom",
        "ScheduleZoneName": "example.com",
        "ScheduleHostname": "www",
        "ScheduleDomainName": "www.example.com\n",
        "ScheduleRrType": "A",
        "Ttl": 60,
        "AddressPoolLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "AvailableStatus": "available",
        "EnableStatus": "enable",
        "HealthStatus": "ok",
        "Remark": "test",
        "AddressPools": {
          "AddressPool": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressPoolId": "pool-89528023225442****",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": {
                "RequestSource": [
                  "[\"default\"]"
                ]
              },
              "AddressPoolName": "AddressPool-1\n",
              "AddressPoolType": "IPv4",
              "AddressLbStrategy": "round_robin",
              "SequenceLbStrategyMode": "preemptive",
              "EnableStatus": "enable",
              "HealthJudgement": "ok",
              "HealthStatus": "ok",
              "AvailableStatus": "available",
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "ConfigLoggingSwitchStatus": "ENABLE"
      }
    ]
  }
}

エラーコード

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

変更履歴

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