すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud DNS:SearchCloudGtmAddressPools

    ドキュメントセンター

    Alibaba Cloud DNS:SearchCloudGtmAddressPools

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

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AcceptLanguage

    string

    任意

    応答の言語。有効な値：

    • zh-CN：中国語。

    • en-US（デフォルト）：英語。

    en-US
    ClientToken

    string

    任意

    リクエストのべき等性を保証するためのクライアントトークン。このパラメーターには、クライアント側で生成した一意の値を指定してください。クライアントトークンは ASCII 文字のみを含むことができ、最大長は 64 文字です。

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

    PageNumber

    integer

    任意

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

    1
    PageSize

    integer

    任意

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

    20
    AddressPoolName

    string

    任意

    アドレスプールの名前。あいまい検索がサポートされています。

    AddressPool-1
    AddressPoolType

    string

    任意

    アドレスプールのタイプ。完全一致検索がサポートされています。有効な値：

    • IPv4

    • IPv6

    • domain

    IPv4
    EnableStatus

    string

    任意

    アドレスプールのステータス。完全一致検索がサポートされています。有効な値：

    • enable：アドレスプールが有効化されています。

    • disable：アドレスプールが無効化されています。

    enable
    Remark

    string

    任意

    アドレスプールの備考。あいまい検索がサポートされています。

    test
    HealthStatus

    string

    任意

    アドレスプールのヘルスチェックステータス。完全一致検索がサポートされています。有効な値：

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

    ok_alert：警告。アドレスプール内の一部のアドレスが利用できませんが、アドレスプール自体は正常とみなされます。警告状態では、利用可能なアドレスは通常どおり解像されますが、利用できないアドレスは解像されません。

    exceptional：異常。アドレスプール内の一部またはすべてのアドレスが利用できず、アドレスプールは異常とみなされます。

    ok
    AvailableStatus

    string

    任意

    アドレスプールの可用性。完全一致検索がサポートされています。有効な値：

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

    • unavailable：アドレスプールが利用できません。

    available

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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

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

    024-03-15T01:46Z
    UpdateTimestamp

    integer

    アドレスプールが最後に変更されたタイムスタンプ。

    1527690629357
    AddressPoolId

    string

    アドレスプールの固有 ID。

    pool-89528023225442****
    AddressPoolName

    string

    アドレスプールの名前。

    AddressPool-1
    AddressPoolType

    string

    アドレスプールのタイプ。有効な値：

    • IPv4

    • IPv6

    • domain

    IPv4
    AddressLbStrategy

    string

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

    • round_robin：任意のソースからの DNS リクエストに対して、すべてのアドレスが返されます。各応答でアドレスが順次ローテーションされます。

    • sequence：任意のソースからの DNS リクエストに対して、シーケンス番号が最も小さいアドレスが返されます。シーケンス番号が小さいほど優先度が高くなります。最も小さいシーケンス番号を持つアドレスが利用できない場合、次に小さいシーケンス番号を持つアドレスが返されます。

    • weight：各アドレスに重みを指定します。DNS リクエストは重み比率に基づいて解像されます。

    • 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：警告。アドレスプール内の一部のアドレスが利用できませんが、アドレスプール自体は正常とみなされます。警告状態では、利用可能なアドレスは通常どおり解像されますが、利用できないアドレスは解像されません。

    • exceptional：異常。アドレスプール内の一部またはすべてのアドレスが利用できず、アドレスプールは異常とみなされます。

    ok
    AvailableStatus

    string

    アドレスプールの可用性。有効な値：

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

    • unavailable：アドレスプールが利用できません。

    available
    Addresses

    object

    Address

    array<object>

    IP アドレスまたはドメイン名の一覧。

    array<object>

    IP アドレスまたはドメイン名に関する情報。

    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

    string

    リクエストの送信元。Global Traffic Manager (GTM) は、クライアントが使用するローカル DNS (LDNS) サーバーの出口 IP アドレスに基づいてトラフィックをスケジュールします。LDNS サーバーが Extension Mechanisms for DNS (EDNS) クライアントサブネットをサポートしている場合、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：自動モード。アドレスの可用性はヘルスチェックの結果によって決定されます。ヘルスチェックで異常が検出された場合、解像は停止します。ヘルスチェックの結果が正常の場合、解像は再開されます。

    • manual：手動モード。アドレスが異常状態の場合、解像は停止し、ヘルスチェックの結果が正常になっても再開しません。アドレスが正常状態の場合、解像は再開されます。ヘルスチェックで異常が検出された場合、アラートが報告されますが、解像は停止しません。

    auto
    ManualAvailableStatus

    string

    ヘルスチェックに基づくフェールオーバーモードが manual に設定されている場合のアドレスの可用性ステータス。有効な値：

    • available：正常。アドレスは予定通り解像されます。ヘルスチェックで異常が検出された場合、アラートが報告されますが、解像は停止しません。

    • unavailable：異常。解像は停止し、ヘルスチェックの結果が正常になっても再開しません。

    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
    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": "024-03-15T01:46Z",
        "UpdateTimestamp": 1527690629357,
        "AddressPoolId": "pool-89528023225442****",
        "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": "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"
                  }
                ]
              }
            }
          ]
        },
        "Remark": "test"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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