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

Alibaba Cloud DNS:SearchCloudGtmInstanceConfigs

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

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

AcceptLanguage

string

任意

応答の言語。有効な値:

  • zh-CN:中国語

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

zh-CN

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)。これは通常、GTM インスタンスを所有するアカウントと同じアカウントの Alibaba Cloud DNS によって管理されるドメイン名です。

example.com

ScheduleDomainName

string

任意

GTM アクセスドメイン。ホストレコード (ScheduleHostname) とプライマリドメイン名またはサブドメイン名 (ScheduleZoneName) を組み合わせて形成されます。

www.example.com

EnableStatus

string

任意

インスタンス構成のステータス。有効な値:

  • enable:有効。GTM インスタンスのインテリジェントスケジューリングポリシーが有効です。

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

enable

Remark

string

任意

インスタンス構成の備考。

test

HealthStatus

string

任意

インスタンス構成のヘルスステータス。有効な値:

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

  • ok_alert:アラート。GTM アクセスドメインによって参照される一部のアドレスプールが利用できません。この状態では、利用可能なアドレスプールに対しては DNS 名前解決が継続されますが、利用不可能なアドレスプールに対しては停止します。

  • exceptional:異常。GTM アクセスドメインによって参照されるすべてのアドレスプールが利用できません。この場合、フェイルオーバー解決では、シーケンス番号が最も小さい空でないアドレスプールのアドレスを使用して、クライアントが解決結果を確実に受信できるようにします。

ok

AvailableStatus

string

任意

インスタンス構成のサービス可用性ステータス。有効な値:

  • available:インスタンス構成が有効で、そのヘルスステータスが正常またはアラートの場合、GTM アクセスドメインのサービスは利用可能です。

  • unavailable:インスタンス構成が無効であるか、そのヘルスステータスが異常である場合、GTM アクセスドメインのサービスは利用できません。

available

レスポンスフィールド

フィールド

説明

object

RequestId

string

一意のリクエスト ID。

6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF

PageNumber

integer

ページ番号。開始値は 1 です。デフォルト値:1。

1

PageSize

integer

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

20

TotalPages

integer

総ページ数。

1

TotalItems

integer

インスタンス構成の総数。

15

InstanceConfigs

object

InstanceConfig

array<object>

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

array<object>

インスタンス構成。

InstanceId

string

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

gtm-cn-x0r38e0****

ConfigId

string

インスタンス構成の一意の ID。アクセスドメイン名は、同じ GTM インスタンス上に A レコードと AAAA レコードの両方を持つことができ、それぞれが個別の構成を持ちます。この ID は、これらの構成を区別します。

Config-000****

CreateTime

string

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

2024-03-15T01:46Z

CreateTimestamp

integer

インスタンス構成が作成されたタイムスタンプ。

1527690629357

UpdateTime

string

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

2024-03-15T01:46Z

UpdateTimestamp

integer

インスタンス構成が最後に更新されたタイムスタンプ。

1527690629357

VersionCode

string

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

  • standard:Standard Edition

  • ultimate:Ultimate Edition

ultimate

CommodityCode

string

商品コード。有効な値:

  • dns_gtm_public_cn:Alibaba Cloud 中国サイトの商品コード。

  • dns_gtm_public_intl:Alibaba Cloud 国際サイトの商品コード。

dns_gtm_public_cn

ScheduleZoneMode

string

アクセスドメイン名の割り当てモード。有効な値:

  • custom:カスタムアクセスドメイン名。ホストレコードをカスタマイズし、GTM インスタンスアカウントの権威 DNS で管理されているドメインに関連付けることで生成します。

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

custom

ScheduleZoneName

string

GTM アクセスドメイン名のルートドメイン (例:example.com) またはサブドメイン (例:a.example.com)。このドメインは通常、GTM インスタンスと同じアカウントの Alibaba Cloud DNS によって管理されます。

example.com

ScheduleHostname

string

GTM アクセスドメイン名のホストレコード。

www

ScheduleDomainName

string

GTM アクセスドメイン名。ホストレコード (ScheduleHostname) とルートドメインまたはサブドメイン (ScheduleZoneName) を組み合わせて形成されます。

www.example.com

ScheduleRrType

string

アクセスドメイン名のレコードタイプ。有効な値:

  • A:IPv4 アドレス

  • AAAA:IPv6 アドレス

  • CNAME:CNAME レコード

A

Ttl

integer

DNS レコードの Time To Live (TTL) (秒単位)。この値は、アクセスドメイン名のレコードが ISP DNS サーバーによってキャッシュされる期間を決定します。

60

AddressPoolLbStrategy

string

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

  • round_robin:各 DNS リクエストに対して、すべてのアドレスプールをローテーション順で返します。

  • sequence:シーケンス番号が最も小さい (優先度が最も高い) 利用可能なアドレスプールを返します。

  • weight:GTM は、重み比に基づいて DNS リクエストをアドレスプールにルーティングします。

  • source_nearest:GTM はリクエストのソースに基づいてアドレスプールを返し、ユーザーに最寄りのアクセスを提供します。

round_robin

SequenceLbStrategyMode

string

sequence 負荷分散ポリシーを使用する場合、このパラメーターは、優先度の高いアドレスプールが回復したときにトラフィックをどのように処理するかを指定します。有効な値:

  • preemptive:プリエンプティブモードでは、トラフィックは優先度の高いアドレスプールに切り替えられます。

  • non_preemptive:ノンプリエンプティブモードでは、トラフィックは現在のアドレスプールにルーティングされ続けます。

preemptive

AvailableStatus

string

インスタンス構成の可用性ステータス。有効な値:

  • available:インスタンス構成が有効で、そのヘルスステータスが正常です。

  • unavailable:インスタンス構成が無効であるか、そのヘルスステータスが異常です。

available

EnableStatus

string

インスタンス構成の有効ステータス。有効な値:

  • enable:スケジューリングポリシーはアクティブです。

  • disable:スケジューリングポリシーは非アクティブです。

enable

HealthStatus

string

インスタンス構成のヘルスステータス。有効な値:

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

  • ok_alert:参照されている一部のアドレスプールは異常ですが、インスタンス全体はまだ動作しています。正常なプールでは DNS 名前解決が継続されますが、異常なプールでは停止します。

  • exceptional:参照されているすべてのアドレスプールが異常です。GTM は、シーケンス番号が最も小さいフェイルオーバーアドレスプールのアドレスを使用して、フェイルオーバー解決を実行します。

ok

Remark

string

インスタンス構成の備考。

test

AddressPools

object

AddressPool

array<object>

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

array<object>

アドレスプール。

CreateTime

string

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

2024-03-15T01:46Z

CreateTimestamp

integer

アドレスプールが作成されたタイムスタンプ。

1527690629357

UpdateTime

string

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

2024-03-15T01:46Z

UpdateTimestamp

integer

アドレスプールが最後に更新されたタイムスタンプ。

1527690629357

AddressPoolId

string

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

pool-89564504435014**60

WeightValue

integer

アドレスプールの重み。各アドレスプールに重みを設定して、重み比に基づいて DNS リクエストをルーティングできます。有効な値:1 から 100 までの整数。

1

SerialNumber

integer

シーケンスベースの負荷分散に使用されるアドレスプールの優先度。値が小さいほど優先度が高くなり、優先度が最も高いアドレスプールが最初に返されます。

1

RequestSource

object

RequestSource

array

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

string

DNS リクエストのソース。GTM は、クライアントが使用するローカル DNS サーバーの出力 IP アドレスに基づいてトラフィックをルーティングします。ローカル DNS サーバーが EDNS Client Subnet (ECS) をサポートしている場合、GTM はクライアントの IP アドレスに基づいてより正確なルーティングを実行できます。

["default"]

AddressPoolName

string

アドレスプールの名前。

AddressPool-1

AddressPoolType

string

アドレスプールのタイプ。有効な値:

  • IPv4

  • IPv6

  • domain

IPv4

AddressLbStrategy

string

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

  • round_robin:各 DNS リクエストに対して、すべてのアドレスをローテーション順で返します。

  • sequence:シーケンス番号が最も小さい (優先度が最も高い) 利用可能なアドレスを返します。

  • weight:各アドレスに重みを設定できます。DNS リクエストは、その重み比に基づいてアドレスにルーティングされます。

  • source_nearest:GTM はリクエストのソースに基づいてアドレスを返し、ユーザーに最寄りのアクセスを提供します。

round_robin

SequenceLbStrategyMode

string

アドレスの負荷分散ポリシーが sequence の場合、このパラメーターは、優先度の高いアドレスが再び利用可能になった後のサービス回復モードを指定します。有効な値:

  • preemptive:プリエンプティブモードでは、トラフィックは優先度の高いアドレスに切り替えられます。

  • 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

SeqNonPreemptiveSchedule

boolean

このアドレスプールにノンプリエンプティブシーケンシャルスケジューリングを使用するかどうかを示します。このモードは通常、マルチクラウド管理シナリオで使用されます。有効な値:

  • true:はい

  • false:いいえ

false

ConfigLoggingSwitchStatus

string

ENABLE

成功レスポンス

JSONJSON

{
  "RequestId": "6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "InstanceConfigs": {
    "InstanceConfig": [
      {
        "InstanceId": "gtm-cn-x0r38e0****",
        "ConfigId": "Config-000****\n",
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "VersionCode": "ultimate",
        "CommodityCode": "dns_gtm_public_cn",
        "ScheduleZoneMode": "custom",
        "ScheduleZoneName": "example.com",
        "ScheduleHostname": "www",
        "ScheduleDomainName": "www.example.com",
        "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-89564504435014**60",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": {
                "RequestSource": [
                  "[\"default\"]"
                ]
              },
              "AddressPoolName": "AddressPool-1",
              "AddressPoolType": "IPv4",
              "AddressLbStrategy": "round_robin",
              "SequenceLbStrategyMode": "preemptive",
              "EnableStatus": "enable",
              "HealthJudgement": "any_ok",
              "HealthStatus": "ok",
              "AvailableStatus": " available",
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "ConfigLoggingSwitchStatus": "ENABLE"
      }
    ]
  }
}

エラーコード

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

変更履歴

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