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

Alibaba Cloud DNS:DescribeCloudGtmInstanceConfigFullInfo

最終更新日:Mar 26, 2026

Global Traffic Manager (GTM) インスタンスの完全な構成 (アクセスドメイン名、アラート、アドレスプール、アドレスの詳細など) を照会します。

今すぐお試しください

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

get

*GtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

AcceptLanguage

string

任意

応答の言語です。有効な値:

  • zh-CN: 中国語

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

en-US

ClientToken

string

任意

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

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

InstanceId

string

任意

Global Traffic Manager 3.0 インスタンスの ID です。

gtm-cn-wwo3a3h****

ConfigId

string

任意

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

詳細については、「ListCloudGtmInstanceConfigs」をご参照ください。

Config-000****

レスポンスフィールド

フィールド

説明

object

RequestId

string

一意のリクエスト ID です。

29D0F8F8-5499-4F6C-9FDC-1EE13BF55925

InstanceId

string

Global Traffic Manager 3.0 インスタンスの ID です。

gtm-cn-wwo3a3h****

ConfigId

string

インスタンス構成の ID です。 同じアクセスドメイン名と Global Traffic Manager (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

Global Traffic Manager 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

InstanceName

string

GTM インスタンスの名前です。

test

ScheduleZoneMode

string

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

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

  • 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

GTM アクセスドメイン名の DNS レコードタイプです。

  • A: IPv4 アドレス

  • AAAA: IPv6 アドレス

  • CNAME: CNAME (正規名)

A

Ttl

integer

グローバルな TTL (Time To Live) (秒) です。これは、アクセスドメイン名をアドレスプール内のアドレスにマッピングする DNS レコードの TTL 値です。キャリアの Local DNS サーバー上の DNS レコードのキャッシュ期間に影響します。TTL 値はカスタマイズできます。

60

AddressPoolLbStrategy

string

アドレスプールの負荷分散ポリシーです。

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

  • sequence: すべての DNS リクエストに対して、最も小さい序数のアドレスプールを返します。序数はアドレスプールの優先度を示します。値が小さいほど優先度が高くなります。最も小さい序数のアドレスプールが利用できない場合、次に小さい序数のアドレスプールが返されます。

  • weight: 各アドレスプールに指定された重みに基づいてアドレスプールを返します。

  • source_nearest: 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 リクエストはフェイルオーバー措置として、最も小さい序数を持つ空でないアドレスプールのアドレスに解決されます。これにより、クライアントが DNS 応答を受信できることが保証されます。

ok

AlertGroup

string

アラートグループです。

[\"云账号报警联系人\"]

AlertConfig

string

アラート通知設定です。

[{\"NoticeType\":\"addr_alert\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_resume\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_pool_unavailable\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true},{\"NoticeType\":\"addr_pool_available\",\"SmsNotice\":true,\"EmailNotice\":true,\"DingtalkNotice\":true}]"

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 までの整数です。各アドレスプールに異なる重みを設定して、指定された重み比に基づいてアドレスプールを返すことができます。

1

SerialNumber

integer

アドレスプールの序数です。すべての DNS リクエストに対して、最も小さい序数のアドレスプールが返されます。序数はアドレスプールの優先度を示します。値が小さいほど優先度が高くなります。

1

RequestSource

object

RequestSource

array

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

string

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

["default"]

AddressPoolName

string

アドレスプールの名前です。

AddressPool-1

AddressPoolType

string

アドレスプールのタイプです。

  • IPv4

  • IPv6

  • domain

IPv4

AddressLbStrategy

string

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

  • round_robin: すべての DNS リクエストに対してすべてのアドレスを返します。アドレスはリクエストごとに順番にローテーションされます。

  • sequence: すべての DNS リクエストに対して、最も小さい序数のアドレスを返します。序数はアドレスの優先度を示します。値が小さいほど優先度が高くなります。最も小さい序数のアドレスが利用できない場合、次に小さい序数のアドレスが返されます。

  • weight: 各アドレスに指定された重みに基づいてアドレスを返します。

  • source_nearest: DNS リクエストのソースに基づいて異なるアドレスを返します。これにより、ユーザーの近接アクセスが実装されます。

round_robin

SequenceLbStrategyMode

string

アドレスの負荷分散ポリシーがシーケンスの場合、このパラメーターは再び利用可能になったリソースのサービス回復モードを指定します。

  • 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

Addresses

object

Address

array<object>

アドレスのリストです。

array<object>

アドレスに関する情報です。

CreateTime

string

アドレスが作成された時刻です。

2024-03-15T01:46Z

CreateTimestamp

integer

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

1527690629357

UpdateTime

string

アドレスが最後に変更された時刻です。

2024-03-15T01:46Z

UpdateTimestamp

integer

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

1527690629357

AddressId

string

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

addr-89564712295703****

WeightValue

integer

アドレスの重みです。値は 1 から 100 までの整数です。各アドレスに異なる重みを設定して、指定された重み比に基づいてアドレスを返すことができます。

1

SerialNumber

integer

アドレスの序数です。これはアドレスの優先度を示します。値が小さいほど優先度が高くなります。

1

RequestSource

object

RequestSource

array

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

string

DNS リクエストのソースです。GTM は、クライアントが使用するローカル DNS サーバーの出口 IP アドレスに基づいてトラフィックをスケジューリングします。ローカル DNS サーバーが EDNS (Extension Mechanisms for DNS) クライアントサブネット (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

アドレスのフェイルオーバーモードが手動の場合、このパラメーターはアドレスの可用性ステータスを指定します。

  • 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

SeqNonPreemptiveSchedule

boolean

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

  • true: はい

  • false: いいえ

false

SeqNonPreemptiveSchedule

boolean

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

  • true: はい

  • false: いいえ

false

成功レスポンス

JSONJSON

{
  "RequestId": "29D0F8F8-5499-4F6C-9FDC-1EE13BF55925",
  "InstanceId": "gtm-cn-wwo3a3h****",
  "ConfigId": "Config-000****",
  "CreateTime": "2024-03-15T01:46Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-15T01:46Z",
  "UpdateTimestamp": 1527690629357,
  "VersionCode": "ultimate",
  "CommodityCode": "dns_gtm_public_cn",
  "InstanceName": "test",
  "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",
  "AlertGroup": "[\\\"云账号报警联系人\\\"]",
  "AlertConfig": "[{\\\"NoticeType\\\":\\\"addr_alert\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_resume\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_pool_unavailable\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true},{\\\"NoticeType\\\":\\\"addr_pool_available\\\",\\\"SmsNotice\\\":true,\\\"EmailNotice\\\":true,\\\"DingtalkNotice\\\":true}]\"",
  "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",
        "AddressPoolType": "IPv4",
        "AddressLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "EnableStatus": "enable",
        "HealthJudgement": "any_ok",
        "HealthStatus": "ok",
        "AvailableStatus": "available",
        "Addresses": {
          "Address": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressId": "addr-89564712295703****",
              "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",
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "SeqNonPreemptiveSchedule": false
      }
    ]
  }
}

エラーコード

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

変更履歴

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