DescribeDnsGtmMonitorConfig - Alibaba Cloud DNS - Alibaba Cloud ドキュメントセンター

アドレスプールのヘルスチェック構成を照会します。

今すぐお試しください

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

get

*gtmInstance

acs:alidns::{#accountId}:gtmInstance/{#gtmInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Lang	string	任意	レスポンスの言語。デフォルト値：en。有効な値：en、zh、ja。	en
MonitorConfigId	string	必須	ヘルスチェック構成の ID。詳細については、「DescribeDnsGtmInstanceAddressPool」をご参照ください。	Moni*******

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	一意のリクエスト ID。	6856BCF6-11D6-4D7E-AC53-FD579933522B
Timeout	integer	タイムアウト期間。単位：ミリ秒。	3000
ProtocolType	string	ヘルスチェックプロトコル。有効な値： HTTP HTTPS PING TCP	TCP
IspCityNodes	object
IspCityNode	array<object>	監視ノードのリスト。
	object	監視ノード。
CityCode	string	都市コード。	572
CountryName	string	表示される国名。	中国
IspCode	string	キャリアコード。	123
CityName	string	表示される都市名。	青岛市
CountryCode	string	国別コード。	001
IspName	string	キャリアの名前。	阿里巴巴
CreateTime	string	構成が作成された日時。	2017-12-28T13:08Z
UpdateTime	string	構成が最後に更新された日時。	2018-01-03T08:57Z
EvaluationCount	integer	連続エラー回数。	3
UpdateTimestamp	integer	構成が最後に更新された日時を示すタイムスタンプ。	1527690629357
MonitorExtendInfo	string	拡張情報。パラメーターはプロトコルによって異なります。 HTTP および HTTPS の場合： port：ヘルスチェックポート。 host：Host ヘッダー。 path：URL パス。 code：期待される HTTP ステータスコード。 failureRate：エラー率。 sni：Server Name Indication（ SNI ）を有効にするかどうかを指定します。このパラメーターは、プロトコルが HTTPS に設定されている場合にのみ有効です。 true：SNI を有効にします。 false：SNI を無効にします。 nodeType：アドレスプールタイプが DOMAIN の場合のヘルスチェックの監視ノードのタイプ。 IPV4 IPV6 PING の場合： failureRate：エラー率。 packetNum：ping パケットの数。 packetLossRate：パケット損失率。 nodeType：アドレスプールタイプが DOMAIN の場合のヘルスチェックの監視ノードのタイプ。 IPV4 IPV6 TCP の場合： port：ヘルスチェックポート。 failureRate：エラー率。 nodeType：アドレスプールタイプが DOMAIN の場合のヘルスチェックの監視ノードのタイプ。 IPV4 IPV6	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
MonitorConfigId	string	ヘルスチェック構成の ID。	Monit*********
CreateTimestamp	integer	構成が作成された日時を示すタイムスタンプ。	1527690629357
Interval	integer	ヘルスチェック間隔。単位：秒。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "Timeout": 3000,
  "ProtocolType": "TCP",
  "IspCityNodes": {
    "IspCityNode": [
      {
        "CityCode": "572",
        "CountryName": "中国",
        "IspCode": "123",
        "CityName": "青岛市",
        "CountryCode": "001",
        "IspName": "阿里巴巴"
      }
    ]
  },
  "CreateTime": "2017-12-28T13:08Z",
  "UpdateTime": "2018-01-03T08:57Z",
  "EvaluationCount": 3,
  "UpdateTimestamp": 1527690629357,
  "MonitorExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}",
  "MonitorConfigId": "Monit*********",
  "CreateTimestamp": 1527690629357,
  "Interval": 1
}

エラーコード

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

変更履歴

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