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

Alibaba Cloud DNS:DescribeGtmInstances

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

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Lang

string

任意

言語。

en

PageNumber

integer

任意

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

1

PageSize

integer

任意

ページングクエリで各ページに返すエントリの数。最大値は 100 です。デフォルト値は 20 です。

20

Keyword

string

任意

インスタンス ID またはインスタンス名で完全に一致検索するためのキーワード。

test

ResourceGroupId

string

任意

リソースグループの ID。

rg-xxxxx

NeedDetailAttributes

boolean

任意

詳細情報を返すかどうかを指定します。デフォルト値は false です。

false

レスポンスフィールド

フィールド

説明

object

PageSize

integer

各ページに返されるエントリの数。

20

RequestId

string

リクエストの一意の ID。

193B0163-7F93-42DF-AB05-ACEEB7D22707

PageNumber

integer

返されたページのページ番号。

1

GtmInstances

object

GtmInstance

array<object>

GTM インスタンスのリスト。

object

ExpireTime

string

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

2018-06-06T11:34Z

AccessStrategyNum

integer

アクセス ポリシーの数。

5

CreateTime

string

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

2018-06-06T11:34Z

CnameMode

string

接続タイプ。有効な値:

  • SYSTEM_ASSIGN: システム割り当て

  • CUSTOM: カスタム

CUSTOM

InstanceId

string

インスタンスの ID。

gtm-cn-wwo3a3hbz**

ExpireTimestamp

integer

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

1528284856000

Ttl

integer

グローバル TTL。

60

AlertGroup

string

アラート連絡グループ。

[\"研发组\"]

AddressPoolNum

integer

アドレスプールの数。

5

InstanceName

string

インスタンスの名前。

test

LbaStrategy

string

負荷分散ポリシー。

  • ALL_RR: ラウンドロビン

  • RATIO: 加重ラウンドロビン

RATIO

Cname

string

インスタンスアクセス用の CNAME。

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

VersionCode

string

バージョンコード。

biaozhun

UserDomainName

string

カスタムドメイン名。

dns-example.top

CreateTimestamp

integer

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

1528284856000

ResourceGroupId

string

リソースグループの ID。

rg-acfm2q2jqpjh***

TotalPages

integer

ページの総数。

1

TotalItems

integer

アイテムの総数。

1

成功レスポンス

JSONJSON

{
  "PageSize": 20,
  "RequestId": "193B0163-7F93-42DF-AB05-ACEEB7D22707",
  "PageNumber": 1,
  "GtmInstances": {
    "GtmInstance": [
      {
        "ExpireTime": "2018-06-06T11:34Z",
        "AccessStrategyNum": 5,
        "CreateTime": "2018-06-06T11:34Z",
        "CnameMode": "CUSTOM",
        "InstanceId": "gtm-cn-wwo3a3hbz**",
        "ExpireTimestamp": 1528284856000,
        "Ttl": 60,
        "AlertGroup": "[\\\"研发组\\\"]",
        "AddressPoolNum": 5,
        "InstanceName": "test",
        "LbaStrategy": "RATIO",
        "Cname": "gtm-cn-wwo3a3hbz**.dns-example.top\n",
        "VersionCode": "biaozhun",
        "UserDomainName": "dns-example.top",
        "CreateTimestamp": 1528284856000,
        "ResourceGroupId": "rg-acfm2q2jqpjh***"
      }
    ]
  },
  "TotalPages": 1,
  "TotalItems": 1
}

エラーコード

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

変更履歴

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