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

Alibaba Cloud DNS:ListCloudGtmAddressPools

最終更新日:Apr 02, 2026

アドレスプールの一覧を返します。

今すぐお試しください

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

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

AcceptLanguage

string

任意

応答の言語です。有効な値:

  • zh-CN: 中国語。

  • en-US: 英語。これがデフォルト値です。

en-US

ClientToken

string

任意

リクエストのべき等性を保証するために使用される、クライアント生成トークンです。トークンが異なるリクエスト間で一意であることを確認してください。トークンには最大 64 個の ASCII 文字を含めることができます。

1ae05db4-10e7-11ef-b126-00163e24****

PageNumber

integer

任意

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

1

PageSize

integer

任意

各ページで返されるエントリ数です。最大値は 100 です。デフォルト値は 20 です。

20

AddressPoolName

string

任意

アドレスプールの名前です。

AddressPool-1

AddressPoolType

string

任意

アドレスプールのタイプです。有効な値:

  • IPv4: アドレスプールには IPv4 アドレスが含まれます。

  • IPv6: アドレスプールには IPv6 アドレスが含まれます。

  • domain: アドレスプールにはドメイン名が含まれます。

IPv4

EnableStatus

string

任意

アドレスプールのステータスです。有効な値:

  • enable: アドレスプールは有効です。

  • disable: アドレスプールは無効です。

enable

Remark

string

任意

アドレスプールの備考です。

test

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID です。

536E9CAD-DB30-4647-AC87-AA5CC38C5382

PageNumber

integer

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

1

PageSize

integer

各ページで返されるエントリ数です。最大値は 100 です。デフォルト値は 20 です。

20

TotalPages

integer

総ページ数です。

1

TotalItems

integer

総アドレスプール数です。

11

AddressPools

object

AddressPool

array<object>

アドレスプールの一覧です。

array<object>

アドレスプールに関する情報です。

CreateTime

string

アドレスプールが作成された時刻です。

2024-03-15T01:46Z

CreateTimestamp

integer

アドレスプールが作成されたことを示すタイムスタンプです。

1527690629357

UpdateTime

string

アドレスプールが最後に変更された時刻です。

2024-03-15T01:46Z

UpdateTimestamp

integer

アドレスプールが最後に変更されたことを示すタイムスタンプです。

1527690629357

AddressPoolId

string

アドレスプール ID です。

pool-89528023225442**16

AddressPoolName

string

アドレスプールの名前です。

AddressPool-1

AddressPoolType

string

アドレスプールのタイプです。有効な値:

  • IPv4

  • IPv6

  • domain

IPv4

AddressLbStrategy

string

アドレスプール内のアドレスに対する負荷分散ポリシーです。有効な値:

  • round_robin: ラウンドロビン。すべてのリクエストに対して、アドレスはシーケンスで返されます。

  • sequence: シーケンシャル。シーケンシャル番号が小さいアドレスほど優先度が高く、最初に返されます。シーケンシャル番号が小さいアドレスが利用不可の場合、シーケンス内の次のアドレスが返されます。

  • weight: 重み付け。各アドレスに重みを設定できます。アドレスは重み比率に基づいて返されます。

  • source_nearest: ソースベースの最寄りのリターン。Global Traffic Manager (GTM) は、DNS リクエストのソースに基づいて異なるアドレスを返し、近接ベースのアクセスを実装します。

round_robin

SequenceLbStrategyMode

string

負荷分散ポリシーが sequence の場合のプライマリアドレスのサービス回復モードです。有効な値:

  • preemptive: プリエンプティブモード。アドレスが回復した後、システムは優先的にシーケンシャル番号が小さいアドレスを使用します。

  • non_preemptive: 非プリエンプティブモード。以前のアドレスが回復した後も、システムは現在のアドレスを継続して使用します。

preemptive

EnableStatus

string

アドレスプールのステータスです。有効な値:

  • enable: アドレスプールは有効です。

  • disable: アドレスプールは無効です。

enable

HealthJudgement

string

アドレスプールのヘルスステータスを決定するための条件です。有効な値:

  • any_ok: 少なくとも1つのヘルスチェックプローブが正常です。

  • p30_ok: 少なくとも30%のヘルスチェックプローブが正常です。

  • p50_ok: 少なくとも50%のヘルスチェックプローブが正常です。

  • p70_ok: 少なくとも70%のヘルスチェックプローブが正常です。

  • all_ok: すべてのヘルスチェックプローブが正常です。

any_ok

HealthStatus

string

アドレスプールのヘルスステータスです。有効な値:

  • ok: 正常。アドレスプール内のすべてのアドレスが利用可能です。

  • ok_alert: 警告。アドレスプール内の一部のアドレスは利用不可ですが、アドレスプールは依然として正常と見なされます。この状態では、利用可能なアドレスに対しては DNS 解決が実行されますが、利用不可なアドレスに対しては実行されません。

  • exceptional: 異常。アドレスプール内の一部またはすべてのアドレスが利用不可であり、アドレスプールは異常と見なされます。

ok

AvailableStatus

string

アドレスプールの可用性ステータスです。有効な値:

  • available: アドレスプールは利用可能です。

  • unavailable: アドレスプールは利用不可です。

available

Addresses

object

Address

array<object>

アドレスの一覧です。

array<object>

アドレスに関する情報です。

CreateTime

string

アドレスが作成された時刻です。

2024-03-15T01:46Z

CreateTimestamp

integer

アドレスが作成されたことを示すタイムスタンプです。

1527690629357

UpdateTime

string

アドレスの最終更新時間。

2024-03-15T01:46Z

UpdateTimestamp

integer

アドレスが最後に変更されたことを示すタイムスタンプです。

1527690629357

AddressId

string

アドレス ID です。

addr-89518218114368****

WeightValue

integer

アドレスの重みです。値は 1 から 100 までの整数です。各アドレスに重みを設定できます。DNS リクエストは重み比率に基づいて解決されます。

1

SerialNumber

integer

アドレスのシーケンシャル番号です。この番号はアドレスの優先度を示します。値が小さいほど優先度が高いことを示します。

1

RequestSource

object

RequestSource

array

リクエストソースの一覧です。

string

リクエストのソースです。GTM は、ユーザーが使用するローカル DNS (LDNS) サーバの送信元 IP アドレスに基づいてトラフィックをスケジュールします。LDNS サーバが Extension Mechanisms for DNS (EDNS) Client Subnet (ECS) をサポートしている場合、GTM はユーザーの IP アドレスに基づいてトラフィックをスケジュールすることもできます。

["default"]

Name

string

アドレスの名前です。

Address-1

Type

string

アドレスのタイプです。有効な値:

  • IPv4: IPv4 アドレス

  • IPv6: IPv6 アドレス

  • domain: ドメイン名

IPv4

Address

string

IP アドレスまたはドメイン名です。

223.5.XX.XX

AttributeInfo

string

アドレスのソースです。このパラメーターは現在のバージョンでは返されません。

当前版本不支持返回此参数。

Remark

string

アドレスの備考です。

test

EnableStatus

string

アドレスのステータスです。有効な値:

  • enable: アドレスは有効です。

  • disable: アドレスは無効です。

enable

AvailableMode

string

アドレスに対するヘルスチェックベースのフェールオーバーメソッドです。有効な値:

  • auto: 自動フェールオーバー。ヘルスチェック結果が異常の場合、DNS 解決は停止します。ヘルスチェック結果が正常の場合、DNS 解決は再開されます。

  • manual: 手動フェールオーバー。アドレスが異常状態の場合、DNS 解決は停止します。ヘルスチェック結果が正常であっても DNS 解決は再開されません。アドレスが正常状態の場合、DNS 解決は再開されます。ヘルスチェック結果が異常の場合、アラートが生成されますが、DNS 解決は停止しません。

auto

ManualAvailableStatus

string

AvailableMode の値が manual の場合のアドレスの可用性ステータスです。有効な値:

  • available: 正常。この状態では、アドレスに対して DNS 解決が実行されます。ヘルスチェック結果が異常な場合、アラートが生成されますが、DNS 解決は停止しません。

  • unavailable: 異常。この状態では、DNS 解決は停止します。ヘルスチェック結果が正常であっても DNS 解決は再開されません。

available

AvailableStatus

string

アドレスの可用性ステータスです。有効な値:

  • available: アドレスは利用可能です。

  • unavailable: アドレスは利用不可です。

available

HealthStatus

string

アドレスのヘルスステータスです。有効な値:

  • ok: アドレスのすべてのヘルスチェックプローブが正常です。

  • ok_alert: アドレスの一部のヘルスチェックプローブは異常ですが、アドレスは依然として正常と見なされます。

  • ok_no_monitor: アドレスはどのヘルスチェックテンプレートとも関連付けられておらず、正常と見なされます。

  • exceptional: アドレスの一部またはすべてのヘルスチェックプローブが異常であり、アドレスは異常と見なされます。

ok

HealthJudgement

string

アドレスのヘルスステータスを決定するための条件です。有効な値:

  • any_ok: 少なくとも1つのヘルスチェックプローブが正常です。

  • p30_ok: 少なくとも30%のヘルスチェックプローブが正常です。

  • p50_ok: 少なくとも50%のヘルスチェックプローブが正常です。

  • p70_ok: 少なくとも70%のヘルスチェックプローブが正常です。

  • all_ok: すべてのヘルスチェックプローブが正常です。

any_ok

HealthTasks

object

HealthTask

array<object>

ヘルスチェックタスクの一覧です。

object

ヘルスチェックタスクに関する情報です。

Port

integer

チェックされるアドレスのサービスポートです。このパラメーターは、ヘルスチェックプロトコルが PING の場合はサポートされません。

80

TemplateId

string

ヘルスチェックテンプレート ID です。

mtp-89518052425100****

TemplateName

string

ヘルスチェックテンプレートの名前です。

IPv4-Ping

SeqNonPreemptiveSchedule

boolean

アドレスがハイブリッドクラウド管理シナリオにおけるシーケンシャル非プリエンプティブスケジューリングオブジェクトであるかどうかを示します。有効な値:

  • true

  • false

false

Remark

string

アドレスプールの備考です。

test

成功レスポンス

JSONJSON

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 11,
  "AddressPools": {
    "AddressPool": [
      {
        "CreateTime": "2024-03-15T01:46Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "AddressPoolId": "pool-89528023225442**16",
        "AddressPoolName": "AddressPool-1",
        "AddressPoolType": "IPv4",
        "AddressLbStrategy": "round_robin",
        "SequenceLbStrategyMode": "preemptive",
        "EnableStatus": "enable",
        "HealthJudgement": "any_ok",
        "HealthStatus": "ok",
        "AvailableStatus": "available",
        "Addresses": {
          "Address": [
            {
              "CreateTime": "2024-03-15T01:46Z",
              "CreateTimestamp": 1527690629357,
              "UpdateTime": "2024-03-15T01:46Z",
              "UpdateTimestamp": 1527690629357,
              "AddressId": "addr-89518218114368****",
              "WeightValue": 1,
              "SerialNumber": 1,
              "RequestSource": {
                "RequestSource": [
                  "[\"default\"]"
                ]
              },
              "Name": "Address-1",
              "Type": "IPv4",
              "Address": "223.5.XX.XX",
              "AttributeInfo": "当前版本不支持返回此参数。",
              "Remark": "test",
              "EnableStatus": "enable",
              "AvailableMode": "auto",
              "ManualAvailableStatus": "available",
              "AvailableStatus": "available",
              "HealthStatus": "ok",
              "HealthJudgement": "any_ok",
              "HealthTasks": {
                "HealthTask": [
                  {
                    "Port": 80,
                    "TemplateId": "mtp-89518052425100****",
                    "TemplateName": "IPv4-Ping"
                  }
                ]
              },
              "SeqNonPreemptiveSchedule": false
            }
          ]
        },
        "Remark": "test"
      }
    ]
  }
}

エラーコード

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

変更履歴

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