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

Alibaba Cloud DNS:DescribeDnsGtmInstance

最終更新日:Sep 09, 2025

指定されたインスタンス ID に基づいて、インスタンスの詳細を照会します。

今すぐお試しください

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

get

*gtmInstance

acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Lang

string

任意

レスポンスの言語。デフォルトは en です。有効な値: en 、 zh 、および ja 。

en

InstanceId

string

必須

インスタンスの ID 。詳細については、DescribeDnsGtmInstances をご参照ください。

gtm-cn-wwo3a3hbz**

レスポンスフィールド

フィールド

説明

object

ExpireTimestamp

integer

インスタンスの有効期限が切れる UNIX タイムスタンプ。

1602656937000

RequestId

string

一意のリクエスト ID 。

84314904-D047-4176-A0EC-256D7F68C7F5

ResourceGroupId

string

リソースグループの ID 。

resourc*****

InstanceId

string

インスタンスの ID 。

gtm-cn-wwo3a3hbz**

TaskQuota

integer

ヘルスチェック タスク数のクォータ。

100

Config

object

インスタンス構成。

Ttl

integer

グローバル TTL 。

60

AlertGroup

string

アラート連絡グループ。 値は JSON フォーマットの List<string> です。

["test1","test2"]

CnameType

string

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

  • PUBLIC: インターネット向け

PUBLIC

StrategyMode

string

アクセス ポリシー モード。

  • LATENCY: 待ち時間ベース

  • GEO: 地理ベース

GEO

InstanceName

string

インスタンスの名前。

test

PublicCnameMode

string

パブリック CNAME のアクセス方法。

  • CUSTOM: カスタム

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

CUSTOM

AlertConfig

object

AlertConfig

array<object>

アラート通知方法。

object

SmsNotice

boolean

ショートメッセージ通知が有効かどうかを示します。

  • true: 有効

  • false または null : 無効

true

NoticeType

string

アラートイベントのタイプ。

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

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

  • ADDR_POOL_GROUP_UNAVAILABLE: アドレスプールグループが利用できません。

  • ADDR_POOL_GROUP_AVAILABLE: アドレスプールグループが復元されました。

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

  • MONITOR_NODE_IP_CHANGE: 監視ノードの IP アドレスが変更されます。

ADDR_ALERT

EmailNotice

boolean

メール通知が有効かどうかを示します。

  • true: 有効

  • false または null : 無効

true

DingtalkNotice

boolean

DingTalk 通知が有効かどうかを示します。

  • true: 有効

  • false または null : 無効

true

PublicUserDomainName

string

ユーザーのパブリック サービス ドメイン名。

example.com

PubicZoneName

string

パブリック アクセス ドメイン名。

gtm-cn-wwo3a3hbz**.example.com

PublicRr

string

パブリック アクセスのホスト名。

test.rr

CreateTime

string

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

2020-10-14T06:58Z

SmsQuota

integer

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

100

VersionCode

string

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

standard

PaymentType

string

課金方法。

  • Subscription: サブスクリプション

Subscription

ExpireTime

string

有効期限。

2020-10-14T06:58Z

CreateTimestamp

integer

インスタンスが作成された時間の UNIX タイムスタンプ。

1602656937000

UsedQuota

object

使用済みクォータ。

EmailUsedCount

integer

送信されたメール通知の数。

123

TaskUsedCount

integer

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

123

SmsUsedCount

integer

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

123

DingtalkUsedCount

integer

送信された DingTalk 通知の数。

123

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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