DescribeCloudGtmAddress API リファレンス - DNS

指定された入力パラメーターに基づいて、アドレスの構成をクエリします。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AcceptLanguage	string	任意	レスポンスの言語。有効な値： zh-CN：中国語 en-US（デフォルト）：英語	en-US
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。トークンが異なるリクエスト間で一意であることを確認してください。トークンには最大 64 ASCII 文字を含めることができます。	1ae05db4-10e7-11ef-b126-00163e24****
AddressId	string	必須	アドレスの一意の ID。	addr-89518218114368****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	一意のリクエスト ID。	B57C121B-A45F-44D8-A9B2-13E5A5044195
AddressId	string	アドレスの一意の ID。	addr-89518218114368****
CreateTime	string	アドレスが作成された時間。	2024-03-23T13:09Z
CreateTimestamp	integer	アドレスが作成された時間の UNIX タイムスタンプ。	1527690629357
UpdateTime	string	アドレス設定が最後に変更された時間。	2024-03-29T13:20Z
UpdateTimestamp	integer	アドレスが最後に変更された時間の UNIX タイムスタンプ。	1527690629357
Name	string	アドレスの名前。	test
Type	string	アドレスのタイプ。有効な値： IPv4 IPv6 domain	IPv4
Address	string	IP アドレスまたはドメイン名。	223.5.XX.XX
AttributeInfo	string	アドレスの属性情報。	当前版本不支持此参数，不会返回地址归属信息。
Remark	string	備考。	test1
EnableStatus	string	アドレスの有効化ステータス： enable：アドレスは有効です。 disable：アドレスは無効です。	enable
AvailableMode	string	ヘルスチェックで例外が検出された場合のアドレスのスイッチオーバモード： auto：自動モード。システムは、ヘルスチェックの結果に基づいて、アドレスの DNS 解決を停止するか再開するかを決定します。アドレスが異常な場合は DNS 解決が停止され、アドレスが正常になると再開されます。 manual：手動モード。アドレスステータスを手動で制御します。アドレスが異常な場合に設定されていると、DNS 解決は停止され、ヘルスチェックの結果が正常であっても再開されません。アドレスが正常に設定されていると、DNS 解決が実行されます。ヘルスチェックで例外が検出された場合、アラートがトリガーされますが、DNS 解決は停止されません。	auto
ManualAvailableStatus	string	スイッチオーバモードが手動の場合に設定されるアドレスの可用性ステータス： available：アドレスは使用可能です。アドレスに対して DNS 解決が実行されます。ヘルスチェックで例外が検出された場合、アラートがトリガーされますが、DNS 解決は停止されません。 unavailable：アドレスは使用できません。アドレスの 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	ヘルスチェックテンプレートの名前。	Ping-IPv4
MonitorStatus	string	ヘルスチェックテンプレートからのヘルスチェックタスクのステータス： ok：正常。 alert：アラート。 no_data：データがありません。このステータスは通常、ヘルスチェックタスクが作成されたばかりで、データがまだ収集されていない場合に表示されます。	ok

例

成功レスポンス

JSONJSON

{
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "AddressId": "addr-89518218114368****\n",
  "CreateTime": "2024-03-23T13:09Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-29T13:20Z",
  "UpdateTimestamp": 1527690629357,
  "Name": "test",
  "Type": "IPv4",
  "Address": "223.5.XX.XX",
  "AttributeInfo": "当前版本不支持此参数，不会返回地址归属信息。",
  "Remark": "test1",
  "EnableStatus": "enable",
  "AvailableMode": "auto",
  "ManualAvailableStatus": "available",
  "AvailableStatus": "available",
  "HealthStatus": "ok",
  "HealthJudgement": "p50_ok",
  "HealthTasks": {
    "HealthTask": [
      {
        "Port": 80,
        "TemplateId": "mtp-89518052425100****",
        "TemplateName": "Ping-IPv4",
        "MonitorStatus": "ok"
      }
    ]
  }
}

エラーコード

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

変更履歴

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