DescribeCloudGtmAddressReference API リファレンス - DNS

指定されたアドレスを参照するアドレスプールと Global Traffic Manager (GTM) 3.0 インスタンスをクエリします。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AcceptLanguage	string	任意	レスポンスの言語。有効な値： zh-CN：中国語 en-US：英語（デフォルト）	zh-CN
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントがリクエストごとに一意のトークンを生成していることを確認してください。トークンには最大 64 の ASCII 文字を含めることができます。	1ae05db4-10e7-11ef-b126-00163e24****
AddressId	string	任意	アドレスの一意の ID。	addr-89518218114368****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	一意のリクエスト ID。	536E9CAD-DB30-4647-AC87-AA5CC38C5382
AddressId	string	アドレスの一意の ID。	addr-89564584963974****
Name	string	アドレスの名前。	Address-1
Address	string	IP アドレスまたはドメイン名。	223.5.XX.XX
AddressPools	object
AddressPool	array<object>	アドレスプールのリスト。
	object	アドレスプールに関する情報。
AddressPoolId	string	アドレスプールの ID。	pool-89528023225442****
AddressPoolName	string	アドレスプール名。	AddressPool-1
InstanceConfigs	object
InstanceConfig	array<object>	アドレスプールを参照するインスタンスのリスト。
	object	アドレスプールを参照するインスタンスの構成情報。
InstanceId	string	GTM 3.0 インスタンスの ID。	gtm-cn-zz11t58****
InstanceName	string	インスタンスの名前。	test
ConfigId	string	インスタンス構成の ID。同じアクセスドメイン名と GTM インスタンスに A レコードと AAAA レコードの両方を構成すると、2 つのインスタンス構成が生成されます。 `ConfigId` はインスタンス構成を一意に識別します。	config-00****
VersionCode	string	GTM 3.0 インスタンスのバージョン: standard: Standard Edition ultimate: Ultimate Edition	ultimate
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	スケジューリングドメイン名の DNS レコードタイプ: A: IPv4 アドレス AAAA: AAAA レコード CNAME: Canonical Name	A
Ttl	integer	グローバル Time to Live (TTL)（秒単位）。これは、アクセスドメイン名をアドレスプール内のアドレスに解決する DNS レコードの TTL 値です。キャリアのローカル DNS サーバーの DNS レコードのキャッシュ期間に影響します。カスタム TTL 値を指定できます。	30
AddressPoolLbStrategy	string	アドレスプールの負荷分散ポリシー: round_robin: ポーリング。任意の DNS クエリに対して、すべてのアドレスプールが返されます。アドレスプールの順序は、クエリごとにローテーションされます。 sequence: 順次。任意の DNS クエリに対して、序数が最も低いアドレスプールが返されます。序数が低いほど、優先順位が高いことを示します。アドレスプールが使用できない場合は、次に序数が低いアドレスプールが返されます。 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: 異常。アクセスドメイン名によって参照されるすべてのアドレスプールが使用できません。この場合、序数が最も低い空でないアドレスプールのアドレスがフェールオーバー解決に使用され、クライアントに応答が提供されます。	ok
Remark	string	備考。	test
AddressPoolType	string	アドレスプールのタイプ: IPv4 IPv6 domain	IPv4
AddressLbStrategy	string	アドレスプール内のアドレスの負荷分散ポリシー: round_robin: ポーリング。任意の DNS クエリに対して、すべてのアドレスが返されます。アドレスの順序は、クエリごとにローテーションされます。 sequence: 順次。任意の DNS クエリに対して、序数が最も低いアドレスが返されます。序数が低いほど、優先順位が高いことを示します。アドレスが使用できない場合は、次に序数が低いアドレスが返されます。 weight: 重み付け。アドレスごとに異なる重みを設定できます。DNS クエリは、重み付け比率に基づいてアドレスにルーティングされます。 source_nearest: ソースベース。これはスマート DNS 解決機能です。GTM は、DNS クエリのソースに基づいて異なるアドレスを返すことができます。これにより、ユーザーは最も近いリソースにアクセスできます。	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
Remark	string	アドレスプールに関する備考。	pool-1

例

成功レスポンス

JSONJSON

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "AddressId": "addr-89564584963974****",
  "Name": "Address-1",
  "Address": "223.5.XX.XX",
  "AddressPools": {
    "AddressPool": [
      {
        "AddressPoolId": "pool-89528023225442****",
        "AddressPoolName": "AddressPool-1",
        "InstanceConfigs": {
          "InstanceConfig": [
            {
              "InstanceId": "gtm-cn-zz11t58****",
              "InstanceName": "test",
              "ConfigId": "config-00****",
              "VersionCode": "ultimate",
              "ScheduleZoneName": "example.com\n",
              "ScheduleHostname": "www",
              "ScheduleDomainName": "www.example.com",
              "ScheduleRrType": "A",
              "Ttl": 30,
              "AddressPoolLbStrategy": "round_robin",
              "SequenceLbStrategyMode": " preemptive",
              "AvailableStatus": "available",
              "EnableStatus": "enable",
              "HealthStatus": "ok",
              "Remark": "test"
            }
          ]
        },
        "AddressPoolType": "IPv4",
        "AddressLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "EnableStatus": "enable",
        "HealthJudgement": "any_ok",
        "HealthStatus": "ok",
        "AvailableStatus": "available",
        "Remark": "pool-1"
      }
    ]
  }
}

エラーコード

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

変更履歴

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