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

Alibaba Cloud DNS:DescribeGtmInstanceStatus

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

get

*GtmInstance

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Lang

string

任意

言語。

en

InstanceId

string

必須

インスタンス ID。

gtm-cn-wwo3a3hbz**

レスポンスフィールド

フィールド

説明

object

Status

string

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

  • ALLOW:操作が許可されています。

  • DENY:操作が拒否されています。

ALLOW

StrategyNotAvailableNum

integer

アクティブなアドレスプールが使用できないアクセス ポリシーの数。

10

RequestId

string

一意のリクエスト ID。

389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA

SwitchToFailoverStrategyNum

integer

フェールオーバー アドレスプールに切り替えられたアクセス ポリシーの数。

10

StatusReason

string

インスタンス ステータスの理由のリスト。有効な値:

  • INSTANCE_OPERATE_BLACK_LIST:インスタンスがブラックリストに登録されています。

  • BETA_INSTANCE:インスタンスはパブリック プレビュー中です。

["BETA_INSTANCE"]

AddrNotAvailableNum

integer

使用できないアドレスの数。

10

AddrPoolNotAvailableNum

integer

使用できないアドレスプールの数。

10

成功レスポンス

JSONJSON

{
  "Status": "ALLOW",
  "StrategyNotAvailableNum": 10,
  "RequestId": "389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA",
  "SwitchToFailoverStrategyNum": 10,
  "StatusReason": "[\"BETA_INSTANCE\"]",
  "AddrNotAvailableNum": 10,
  "AddrPoolNotAvailableNum": 10
}

エラーコード

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

変更履歴

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