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

Alibaba Cloud DNS:DescribeGtmInstance

最終更新日:Sep 09, 2025

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:DescribeGtmInstance

get

*gtminstance

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Lang

string

任意

言語。

en

InstanceId

string

必須

GTM インスタンスの ID。

instance1

NeedDetailAttributes

boolean

任意

追加情報を返すかどうかを指定します。デフォルト値は false です。このパラメーターを true に設定すると、レスポンスには AccessStrategyNum(アクセス ポリシーの数)と AddressPoolNum(アドレス プールの数)が含まれます。

false

レスポンスフィールド

フィールド

説明

object

ExpireTimestamp

integer

インスタンスの有効期限。UNIX タイムスタンプです。

1528284856000

UserDomainName

string

カスタム ドメイン名。

dns-example.top

RequestId

string

リクエストのユニーク ID。

E41AA251-F9BA-48C6-99B2-2B82B26A573A

LbaStrategy

string

負荷分散ポリシー。

  • ALL_RR: ラウンドロビン

  • RATIO: 重み付きラウンドロビン

RATIO

InstanceId

string

GTM インスタンスの ID。

gtm-cn-wwo3a3hbz**

CreateTime

string

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

2018-06-06T11:34Z

CnameMode

string

CNAME アクセス モード。有効な値:

  • SYSTEM_ASSIGN: システムがドメイン名を割り当てます。

  • CUSTOM: カスタム ドメイン名を使用します。

CUSTOM

Ttl

integer

グローバル TTL。

60

Cname

string

CNAME アクセス ドメイン名。

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

InstanceName

string

インスタンスの名前。

test

VersionCode

string

バージョン コード。

biaozhun

AlertGroup

string

アラート連絡グループ。

[\"日常测试-研发组\"]

AddressPoolNum

integer

アドレス プールの数。

5

AccessStrategyNum

integer

アクセス ポリシーの数。

5

ExpireTime

string

インスタンスの有効期限が切れる日時。

2018-06-06T11:34Z

CreateTimestamp

integer

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

1528284856000

ResourceGroupId

string

リソース グループの ID。

rg-testgroupid

成功レスポンス

JSONJSON

{
  "ExpireTimestamp": 1528284856000,
  "UserDomainName": "dns-example.top",
  "RequestId": "E41AA251-F9BA-48C6-99B2-2B82B26A573A",
  "LbaStrategy": "RATIO",
  "InstanceId": "gtm-cn-wwo3a3hbz**",
  "CreateTime": "2018-06-06T11:34Z",
  "CnameMode": "CUSTOM",
  "Ttl": 60,
  "Cname": "gtm-cn-wwo3a3hbz**.dns-example.top",
  "InstanceName": "test",
  "VersionCode": "biaozhun",
  "AlertGroup": "[\\\"日常测试-研发组\\\"]",
  "AddressPoolNum": 5,
  "AccessStrategyNum": 5,
  "ExpireTime": "2018-06-06T11:34Z",
  "CreateTimestamp": 1528284856000,
  "ResourceGroupId": "rg-testgroupid"
}

エラーコード

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

変更履歴

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