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

Alibaba Cloud DNS:DescribeDnsGtmInstances

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

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Lang

string

任意

レスポンスの言語。デフォルト値:en。有効な値:en、zh、ja。

en

PageNumber

integer

任意

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

1

PageSize

integer

任意

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

1

Keyword

string

任意

クエリのキーワード。インスタンス ID とインスタンス名によるあいまい検索がサポートされています。

test

ResourceGroupId

string

任意

リソースグループの ID。

rg-testgroupid

レスポンスフィールド

フィールド

説明

object

PageSize

integer

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

1

RequestId

string

一意のリクエスト ID。

84314904-D047-4176-A0EC-256D7F68C7F5

PageNumber

integer

返されるページ番号。値は [1] から始まります。デフォルト値:[1]

1

GtmInstances

array<object>

Global Traffic Manager (GTM) インスタンスのリスト。

object

PaymentType

string

課金方法。有効な値:

  • Subscription

Subscription

ExpireTime

string

インスタンスの有効期限。

2020-10-14T06:58Z

CreateTime

string

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

2020-10-14T06:58Z

SmsQuota

integer

ショートメッセージ通知の合計クォータ。

1

InstanceId

string

インスタンスの ID。

gtm-cn-wwo3a3hbz**

Config

object

インスタンスの構成。

Ttl

integer

グローバル TTL。

60

AlertGroup

string

アラート連絡グループ。値は JSON 形式の文字列リストです。

["test1","test2"]

PublicZoneName

string

インターネットアクセスに使用されるドメイン名。

gtm-cn-wwo3a3hbz**.dns-example.top

CnameType

string

アクセスに使用される CNAME ドメイン名のタイプ。有効な値:

  • PUBLIC:インターネットアクセス用

PUBLIC

StrategyMode

string

アクセスポリシーのモード。有効な値:

  • LATENCY:レイテンシベース

  • GEO:地理ベース

GEO

InstanceName

string

インスタンスの名前。

instanceTest

PublicCnameMode

string

CNAME レコードを使用してインターネット経由でインスタンスにアクセスする方法。有効な値:

  • CUSTOM:カスタム

  • SYSTEM_ASSIGN:システム割り当て (この機能は無効になっています。)

CUSTOM

AlertConfig

array<object>

アラート通知方法。

object

SmsNotice

string

ショートメッセージ通知が構成されているかどうかを示します。有効な値:

  • true:構成済み

  • false または null:未構成

true

NoticeType

string

アラートイベントのタイプ。有効な値:

  • ADDR_ALERT:アドレスが利用できません。

  • ADDR_RESUME:アドレスが復元されました。

  • ADDR_POOL_GROUP_UNAVAILABLE:アドレスプールコレクションが利用できません。

  • ADDR_POOL_GROUP_AVAILABLE:アドレスプールコレクションが復元されました。

  • ACCESS_STRATEGY_POOL_GROUP_SWITCH:プライマリアドレスプールとセカンダリアドレスプールの間でスイッチオーバーが発生します。

ADDR_ALERT

EmailNotice

string

メール通知が構成されているかどうかを示します。有効な値:

  • true:構成済み

  • false または null:未構成

true

DingtalkNotice

string

DingTalk 通知が構成されているかどうかを示します。有効な値:

  • true:構成済み

  • false または null:未構成

true

PublicUserDomainName

string

インターネット経由でアクセスできるユーザーのサービス ドメイン名。

dns-example.top

PublicRr

string

インターネットアクセス用のホスト名。

test.rr

ExpireTimestamp

integer

インスタンスの有効期限を示すタイムスタンプ。

1602658709000

ResourceGroupId

string

リソースグループの ID。

resourceGroupid123

VersionCode

string

インスタンスのバージョン。

standard

UsedQuota

object

使用済みクォータ。

EmailUsedCount

integer

送信されたメールの総数。

100

TaskUsedCount

integer

作成されたヘルスチェック タスクの数。

100

SmsUsedCount

integer

送信されたショートメッセージの総数。

100

DingtalkUsedCount

integer

送信された DingTalk メッセージの総数。

100

TaskQuota

integer

ヘルスチェック タスクの総数。

1

CreateTimestamp

integer

インスタンスが作成された日時を示すタイムスタンプ。

1602658709000

TotalPages

integer

ページの総数。

123

TotalItems

integer

エントリの総数。

100

成功レスポンス

JSONJSON

{
  "PageSize": 1,
  "RequestId": "84314904-D047-4176-A0EC-256D7F68C7F5",
  "PageNumber": 1,
  "GtmInstances": [
    {
      "PaymentType": "Subscription",
      "ExpireTime": "2020-10-14T06:58Z",
      "CreateTime": "2020-10-14T06:58Z",
      "SmsQuota": 1,
      "InstanceId": "gtm-cn-wwo3a3hbz**",
      "Config": {
        "Ttl": 60,
        "AlertGroup": "[\"test1\",\"test2\"]",
        "PublicZoneName": "gtm-cn-wwo3a3hbz**.dns-example.top",
        "CnameType": "PUBLIC",
        "StrategyMode": "GEO",
        "InstanceName": "instanceTest",
        "PublicCnameMode": "CUSTOM",
        "AlertConfig": [
          {
            "SmsNotice": "true",
            "NoticeType": "ADDR_ALERT",
            "EmailNotice": "true",
            "DingtalkNotice": "true"
          }
        ],
        "PublicUserDomainName": "dns-example.top",
        "PublicRr": "test.rr"
      },
      "ExpireTimestamp": 1602658709000,
      "ResourceGroupId": "resourceGroupid123",
      "VersionCode": "standard",
      "UsedQuota": {
        "EmailUsedCount": 100,
        "TaskUsedCount": 100,
        "SmsUsedCount": 100,
        "DingtalkUsedCount": 100
      },
      "TaskQuota": 1,
      "CreateTimestamp": 1602658709000
    }
  ],
  "TotalPages": 123,
  "TotalItems": 100
}

エラーコード

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

変更履歴

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