ListCloudGtmAddresses API による GTM アドレスプールデータの取得 - DNS - Alibaba Cloud - Alibaba Cloud 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:ListCloudGtmAddresses

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AcceptLanguage	string	任意	戻り値の言語。有効な値: zh-CN: 中国語。 en-US: 英語。	en-US
ClientToken	string	任意	リクエストの冪等性を保証するために使用されるクライアントトークン。クライアントはリクエストごとに一意のトークンを生成する必要があります。トークンには最大 64 個のASCII 文字を含めることができます。	1ae05db4-10e7-11ef-b126-00163e24****
Name	string	任意	アドレスの名前。	test
Type	string	任意	アドレスのタイプ。有効な値: IPv4 IPv6 domain	IPv4
Address	string	任意	IPアドレスまたはドメイン名。	223.5.XX.XX
EnableStatus	string	任意	アドレスの状態。有効な値: enable: アドレスが有効です。 disable: アドレスが無効です。	enable
HealthStatus	string	任意	アドレスのヘルスステータス。有効な値: ok: アドレスに関連付けられているすべてのヘルスチェックタスクが正常です。 ok_alert: アドレスに関連付けられている一部のヘルスチェックタスクが異常ですが、アドレスは依然として正常と見なされます。 ok_no_monitor: アドレスに関連付けられているヘルスチェックテンプレートがありません。 exceptional: アドレスに関連付けられている一部またはすべてのヘルスチェックタスクが異常で、アドレスは異常と見なされます。	ok
MonitorTemplateId	string	任意	ヘルスチェックテンプレートの一意のID。	mtp-89518052425100****
PageNumber	integer	必須	ページ番号。値は 1 から始まります。デフォルト値は 1 です。	1
PageSize	integer	必須	ページ分割クエリで1ページあたりに返すエントリ数。最大値は 100 です。デフォルト値は 20 です。	20
AddressId	string	任意	アドレスの一意のID。	addr-89518218114368****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	一意のリクエストID。	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	ページ番号。値は 1 から始まります。デフォルト値は 1 です。	1
PageSize	integer	1ページあたりに返されるエントリ数。最大値は 100 です。デフォルト値は 20 です。	20
TotalPages	integer	ページの総数。	2
TotalItems	integer	アドレスの総数。	30
Addresses	object
Address	array<object>	アドレスのリスト。
	array<object>	アドレスのリスト。
AddressId	string	The address ID. This ID uniquely identifies the address.	addr-89518218114368****
CreateTime	string	Address creation time.	2024-03-23T13:09Z
CreateTimestamp	integer	Creation time (timestamp).	1527690629357
UpdateTime	string	Address modification time.	2024-03-29T13:20Z
UpdateTimestamp	integer	Update time (timestamp).	1527690824357
Name	string	Address name.	Address-1
Type	string	Address type: IPv4 IPv6 domain	IPv4
Address	string	IP address or domain name.	223.5.XX.XX
AttributeInfo	string	Address ownership information.	当前版本不支持此参数，不会返回地址归属信息。
Remark	string	Remarks.	app
EnableStatus	string	Indicates the current availability of the address: enable: Enabled status disable: Disabled status	enable
AvailableMode	string	The failover method that is used if the address fails health checks. Valid values: auto: the automatic mode. The system determines whether to return an address based on the health check results. If the address fails health checks, the system does not return the address. If the address passes health checks, the system returns the address. manual: the manual mode. If an address is in the unavailable state, the address is not returned for Domain Name System (DNS) requests even if the address passes health checks. If an address is in the available state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks.	auto
ManualAvailableStatus	string	The availability state of the address when AvailableMode is set to manual. Valid values: available: The address is normal. In this state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks. unavailable: The address is abnormal. In this state, the address is not returned for DNS requests even if the address passes health checks.	available
AvailableStatus	string	The availability state of the address. Valid values: available: The address is available. unavailable: The address is unavailable.	available
HealthStatus	string	The health check state of the address. Valid values: ok: The address passes all health checks of the referenced health check templates. ok_alert: The address fails some health checks of the referenced health check templates but the address is deemed normal. ok_no_monitor: The address does not reference a health check template. exceptional: The address fails some or all health checks of the referenced health check templates and the address is deemed abnormal.	ok
HealthJudgement	string	The condition for determining the health status of the address. Valid values: any_ok: The health check results of at least one health check template are normal. p30_ok: The health check results of at least 30% of health check templates are normal. p50_ok: The health check results of at least 50% of health check templates are normal. p70_ok: The health check results of at least 70% of health check templates are normal. all_ok: The health check results of all health check templates are normal.	p50_ok
HealthTasks	object
HealthTask	array<object>	The health check tasks referenced by the address.
	object	The health check task referenced by the address.
Port	integer	The target service port for health check probes. When the health check protocol is set to Ping, configuration of the service port is not supported.	80
TemplateId	string	The ID of the health check template associated with the address.	mtp-89518052425100****
TemplateName	string	Health check template name.	Ping-IPv4
MonitorStatus	string	The state of the health check task. Valid values: ok: The task is normal. alert: An alert is triggered. no_data: No data is available. In most cases, the health check task is newly created and no data is collected.	ok

例

成功レスポンス

JSONJSON

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 2,
  "TotalItems": 30,
  "Addresses": {
    "Address": [
      {
        "AddressId": "addr-89518218114368****",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690824357,
        "Name": "Address-1",
        "Type": "IPv4",
        "Address": "223.5.XX.XX",
        "AttributeInfo": "当前版本不支持此参数，不会返回地址归属信息。",
        "Remark": "app",
        "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"
            }
          ]
        }
      }
    ]
  }
}

エラーコード

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

変更履歴

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