DescribeGtmMonitorConfig API リファレンス - Alibaba Cloud DNS (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:DescribeGtmMonitorConfig

get

*gtmInstance

acs:alidns::{#accountId}:gtminstance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Lang	string	任意	言語。	en
MonitorConfigId	string	必須	ヘルスチェック構成の ID。	100

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	一意のリクエスト ID。	6856BCF6-11D6-4D7E-AC53-FD579933522B
Timeout	integer	タイムアウト期間。単位：ミリ秒。有効な値：2000、3000、5000、および 10000。	3000
ProtocolType	string	ヘルスチェックに使用されるプロトコル。	HTTP
IspCityNodes	object
IspCityNode	array<object>	監視ノード。
	object	監視ノード。
CityCode	string	都市コード。	503
CountryName	string	国名の表示名。	中国
IspCode	string	キャリアコード。	465
CityName	string	都市名の表示名。	张家口市
CountryCode	string	国別コード。	001
IspName	string	キャリアの名前。	阿里巴巴
CreateTime	string	ヘルスチェック構成が作成された日時。	2017-12-28T13:08Z
UpdateTime	string	ヘルスチェック構成が最後に更新された日時。	2017-12-28T13:08Z
EvaluationCount	integer	連続ヘルスチェック回数。	3
UpdateTimestamp	integer	ヘルスチェック構成が最後に更新された日時を示す UNIX タイムスタンプ。	1527690629357
MonitorExtendInfo	string	拡張情報。パラメーターはプロトコルによって異なります。 HTTP および HTTPS の場合： port：ヘルスチェックポート。 failureRate：失敗率。 code：リターンコード。レスポンスの状態コードが指定された値よりも大きい場合、異常とみなされます。有効な値：400 および 500。 host：リクエストの Host ヘッダー。 path：URL のパス。 PING の場合： packetNum：ping パケットの数。 packetLossRate：パケット損失率。 failureRate：失敗率。 TCP の場合： port：ヘルスチェックポート。 failureRate：失敗率。	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
MonitorConfigId	string	ヘルスチェック構成の ID。	1234abc
CreateTimestamp	integer	ヘルスチェック構成が作成された日時を示す UNIX タイムスタンプ。	1527690629357
Interval	integer	ヘルスチェック間隔。単位：秒。値は 60 です。	60

例

成功レスポンス

JSONJSON

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "Timeout": 3000,
  "ProtocolType": "HTTP",
  "IspCityNodes": {
    "IspCityNode": [
      {
        "CityCode": "503",
        "CountryName": "中国",
        "IspCode": "465",
        "CityName": "张家口市",
        "CountryCode": "001",
        "IspName": "阿里巴巴"
      }
    ]
  },
  "CreateTime": "2017-12-28T13:08Z",
  "UpdateTime": "2017-12-28T13:08Z",
  "EvaluationCount": 3,
  "UpdateTimestamp": 1527690629357,
  "MonitorExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}",
  "MonitorConfigId": "1234abc",
  "CreateTimestamp": 1527690629357,
  "Interval": 60
}

エラーコード

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

変更履歴

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