SearchCloudGtmAddresses API による GTM アドレスのクエリ - DNS

アドレス名、備考、参照されているヘルスチェックテンプレート、またはアドレス ID などの条件に基づいてアドレスを検索します。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AcceptLanguage	string	任意	戻り値の言語。有効な値： zh-CN：中国語。 en-US：英語。これがデフォルト値です。	en-US
Names	array	任意	アドレスの名前。この名前は、識別を容易にするために使用されます。
	string	任意	アドレス名でクエリを実行するための検索条件。クエリには複数のキーワードを入力できます。	["address_1", "test"]
NameSearchCondition	string	任意	アドレス名でクエリを実行するための検索ロジック。アドレス名でクエリを実行する場合は、このパラメーターが必須です。 and：指定されたすべてのキーワードに一致する結果が返されます。 or：指定されたキーワードの一部またはすべてに一致する結果が返されます。	or
AvailableStatus	string	任意	アドレスの可用性ステータスによる完全一致検索を実行します。 available：アドレスは利用可能です。 unavailable：アドレスは利用できません。	available
Type	string	任意	アドレスタイプによる完全一致検索を実行します。 IPv4 IPv6 domain	IPv4
Address	string	任意	エンドポイントによる完全一致検索を実行します。 IP アドレスとドメイン名がサポートされています。	223.5.XX.XX
MonitorTemplateName	string	任意	ヘルスチェックテンプレートの名前。	Ping-IPv4
EnableStatus	string	任意	アドレスのステータスによる完全一致検索を実行します。 enable：アドレスは有効です。 disable：アドレスは無効です。	enable
HealthStatus	string	任意	アドレスのヘルスステータスによる完全一致検索を実行します。 ok：参照されているヘルスチェックテンプレートのすべてのヘルスチェックタスクは正常です。 ok_alert：参照されているヘルスチェックテンプレートの一部のヘルスチェックタスクは異常ですが、アドレスはまだ正常と見なされています。 ok_no_monitor：アドレスはヘルスチェックテンプレートを参照していません。 exceptional：参照されているヘルスチェックテンプレートの一部またはすべてのヘルスチェックタスクが異常であり、アドレスは異常と見なされます。	ok
Remarks	array	任意	アドレスの備考。
	string	任意	アドレスの備考の検索条件。クエリには複数のキーワードを入力できます。	["", "test"]
RemarkSearchCondition	string	任意	アドレスの備考でクエリを実行するための検索ロジック。アドレスの備考でクエリを実行する場合は、このパラメーターが必須です。 and：指定されたすべてのキーワードに一致する結果が返されます。 or：指定されたキーワードの一部またはすべてに一致する結果が返されます。	or
PageNumber	integer	必須	現在のページ番号。値は 1 から始まります。デフォルト値は 1 です。	1
PageSize	integer	必須	ページングクエリで各ページに返すエントリの数。最大値は 100 です。デフォルト値は 20 です。	20
AddressId	string	任意	アドレスの ID 。アドレス ID は一意の識別子です。	addr-89518218114368****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	一意のリクエスト ID 。	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	現在のページ番号。値は 1 から始まります。デフォルト値は 1 です。	1
PageSize	integer	ページングクエリで各ページに返されるエントリの数。最大値は 100 です。デフォルト値は 20 です。	20
TotalPages	integer	ページの総数。	1
TotalItems	integer	クエリ条件を満たすアドレスの総数。	15
Addresses	object
Address	array<object>	アドレスのリスト。
	object	アドレスのリスト。
AddressId	string	アドレスの ID 。アドレス ID は一意の識別子です。	addr-89518218114368**92
CreateTime	string	アドレスが作成された日時。	2024-03-23T13:09Z
CreateTimestamp	integer	アドレスが作成された日時を示すタイムスタンプ。	1527690629357
UpdateTime	string	アドレスが最後に変更された日時。	2024-03-29T13:20Z
UpdateTimestamp	integer	アドレスが最後に変更された日時を示すタイムスタンプ。	1527690629357
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 解決を停止します。ヘルスチェック結果が正常な場合、システムは 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：すべてのヘルスチェックが正常です。	p50_ok
HealthTasks	object
HealthTask	array<object>	ヘルスチェックタスクのリスト。
	object	アドレスが参照するヘルスチェックタスクに関する情報。
Port	integer	ヘルスチェックの宛先アドレスのサービスポート。ヘルスチェックで Ping プロトコルを使用している場合は、サービスポートを設定できません。	80
TemplateId	string	アドレスに関連付けられているヘルスチェックテンプレートの ID 。	mtp-89518052425100****
TemplateName	string	ヘルスチェックテンプレートの名前。	IPv4-Ping
MonitorStatus	string	ヘルスチェックタスクのステータス： ok：正常。 alert：アラートがトリガーされます。 no_data：データがありません。このステータスは通常、ヘルスチェックタスクが新しく作成され、データがまだ収集されていない場合に発生します。	ok

例

成功レスポンス

JSONJSON

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "Addresses": {
    "Address": [
      {
        "AddressId": "addr-89518218114368**92",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690629357,
        "Name": "Address-1",
        "Type": "IPv4",
        "Address": "223.5.XX.XX",
        "AttributeInfo": "当前版本不返回此参数。",
        "Remark": "test",
        "EnableStatus": "enable",
        "AvailableMode": "auto",
        "ManualAvailableStatus": "available",
        "AvailableStatus": "available",
        "HealthStatus": "ok",
        "HealthJudgement": "p50_ok",
        "HealthTasks": {
          "HealthTask": [
            {
              "Port": 80,
              "TemplateId": "mtp-89518052425100****",
              "TemplateName": "IPv4-Ping",
              "MonitorStatus": "ok"
            }
          ]
        }
      }
    ]
  }
}

エラーコード

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

変更履歴

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