DescribeHostAvailabilityList による可用性モニタリングタスクのクエリ - CMS - Alibaba Cloud - Cloud Monitor

可用性モニタリングタスクのリストを照会します。

操作説明

この Topic では、現在のアカウントの可用性モニタリングタスクのリストをクエリする方法の例を示します。応答は、現在のアカウントに 1 つの可用性モニタリングタスク Record ecs_instance があることを示しています。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:DescribeHostAvailabilityList

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	integer	任意	可用性モニタリングタスクの ID。	123456
Ids	string	任意	複数の可用性モニタリングタスクの ID。複数の ID はコンマ (,) で区切ります。	123456,345678
TaskName	string	任意	可用性モニタリングタスクの名前。	ecs_instance
PageNumber	integer	任意	ページ番号。最小値: 1。デフォルト値: 1。	1
PageSize	integer	任意	ページサイズ。最小値: 1。デフォルト値: 10。	10
GroupId	integer	任意	アプリケーショングループの ID。	12345

共通リクエストパラメーターのフォーマットの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	HTTP 状態コード。説明値 200 は成功を示します。	200
Message	string	エラーメッセージ。	The specified resource is not found.
RequestId	string	リクエスト ID。	4A288E86-45C3-4858-9DB0-6D85B10BD92A
Total	integer	Record の総数。	1
Success	boolean	操作が成功したかどうかを示します。有効な値: true: 操作は成功しました。 false: 操作は失敗しました。	true
TaskList	object
NodeTaskConfig	array<object>	可用性モニタリングタスクのリスト。
	array<object>	可用性モニタリングタスクのリスト。
TaskType	string	タスクタイプ。有効値： PING TELNET HTTP	HTTP
GroupName	string	アプリケーショングループの名前。	Group_ECS
GroupId	integer	アプリケーショングループの ID。	12345
TaskName	string	可用性監視タスクの名前。	ecs_instance
Disabled	boolean	可用性監視タスクが無効になっているかどうかを示します。有効値： true：可用性監視タスクは無効になっています。 false：可用性監視タスクは有効になっています。	false
TaskScope	string	可用性監視タスクによって監視されるインスタンスの範囲。有効値： GROUP：アプリケーショングループ内のすべての ECS インスタンスが監視されます。 GROUP_SPEC_INSTANCE：アプリケーショングループ内の指定された ECS インスタンスが監視されます。	GROUP
Id	integer	可用性監視タスクの ID。	123456
Instances	object
Instance	array	監視対象の ECS インスタンス。
	string	ECS インスタンスの ID。	i-abcdefgh12****
TaskOption	object	可用性監視タスクのオプションパラメーター。
HttpMethod	string	HTTP リクエストメソッド。有効値： GET POST HEAD	GET
Interval	integer	検出リクエストが送信される間隔。単位：秒。	60
HttpURI	string	監視する URI。`TaskType` パラメーターが `HTTP` に設定されている場合、このパラメーターは必須です。	https://www.aliyun.com
TelnetOrPingHost	string	監視するドメイン名または IP アドレス。	ssh.aliyun.com
HttpResponseCharset	string	HTTP 応答で使用される文字セット。	UTF-8
HttpPostContent	string	HTTP POST リクエストの内容。	params1=paramsValue1
HttpNegative	boolean	アラートをトリガーするメソッド。アラートは、指定されたアラートルールが応答本文に含まれているかどうかに基づいてトリガーされます。有効値： true：HTTP 応答本文にアラートルールが含まれている場合、アラートがトリガーされます。 false：HTTP 応答にアラートルールが含まれていない場合、アラートがトリガーされます。	true
HttpKeyword	string	HTTP リクエストへの応答。	OK
AlertConfig	object	アラートルールの構成。
SilenceTime	integer	トリガー条件が満たされても新しいアラートが送信されないミュート期間。単位：秒。デフォルト値：86400。	86400
EndTime	integer	アラートルールが有効な期間の終了時刻。有効値：0～23。たとえば、`AlertConfig.StartTime` パラメーターが 0 に設定され、`AlertConfig.EndTime` パラメーターが 22 に設定されている場合、アラートルールは 00:00:00 から 22:00:00 まで有効です。説明アラート通知は、アラートルールが有効な場合にのみ、指定されたしきい値に基づいて送信されます。	22
StartTime	integer	アラートルールが有効な期間の開始時刻。有効値：0～23。たとえば、`AlertConfig.StartTime` パラメーターが 0 に設定され、`AlertConfig.EndTime` パラメーターが 22 に設定されている場合、アラートルールは 00:00:00 から 22:00:00 まで有効です。説明アラート通知は、アラートルールが有効な場合にのみ、指定されたしきい値に基づいて送信されます。	0
WebHook	string	コールバック URL。 CloudMonitor は、HTTP POST リクエストを送信することで、指定されたコールバック URL にアラート通知をプッシュします。HTTP プロトコルのみがサポートされています。	https://www.aliyun.com
NotifyType	integer	アラート通知方法。有効値： 2：アラート通知は、メールと DingTalk チャットボットを使用して送信されます。 1：アラート通知は、メールと DingTalk チャットボットを使用して送信されます。 0：アラート通知は、メールと DingTalk チャットボットを使用して送信されます。	1
EscalationList	object
escalationList	array<object>	アラートルールのトリガー条件。
	object
Value	string	アラートのしきい値。	400
MetricName	string	メトリックの名前。有効値： HttpStatus HttpLatency TelnetStatus TelnetLatency PingLostRate	HttpStatus
Operator	string	アラートルールで使用される比較演算子。有効値： `>` `>=` `<` `<=` `=`	=
Times	string	アラートがトリガーされる前にメトリック値が測定される連続回数。	3
Aggregate	string	アラートをトリガーするメトリック値を計算するために使用されるメソッド。有効値： Value：HTTP ステータスコードの値 Average：平均 HTTP 応答時間 Value：Telnet 状態コードの値 TelnetLatency：平均 Telnet 応答時間 Average：平均 Ping パケット損失率	Value
TargetList	object
Target	array<object>	監視対象のリソース。
	object
Id	string	アラートをトリガーするリソースの ID。	1
Arn	string	関数の Alibaba Cloud リソース名 (ARN)。フォーマット：`arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。フィールド： Service：サービスコード Region：リージョン ID Account：Alibaba Cloud アカウントの ID ResourceType：リソースタイプ ResourceId：リソース ID。	acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages
Level	string	アラートレベル。有効値： INFO WARN CRITICAL	INFO
JsonParams	string	アラートコールバックの JSON 形式のパラメーター。	{"key1":"value1"}

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "4A288E86-45C3-4858-9DB0-6D85B10BD92A",
  "Total": 1,
  "Success": true,
  "TaskList": {
    "NodeTaskConfig": [
      {
        "TaskType": "HTTP",
        "GroupName": "Group_ECS",
        "GroupId": 12345,
        "TaskName": "ecs_instance",
        "Disabled": false,
        "TaskScope": "GROUP",
        "Id": 123456,
        "Instances": {
          "Instance": [
            "i-abcdefgh12****"
          ]
        },
        "TaskOption": {
          "HttpMethod": "GET",
          "Interval": 60,
          "HttpURI": "https://www.aliyun.com",
          "TelnetOrPingHost": "ssh.aliyun.com",
          "HttpResponseCharset": "UTF-8",
          "HttpPostContent": "params1=paramsValue1",
          "HttpNegative": true,
          "HttpKeyword": "OK"
        },
        "AlertConfig": {
          "SilenceTime": 86400,
          "EndTime": 22,
          "StartTime": 0,
          "WebHook": "https://www.aliyun.com",
          "NotifyType": 1,
          "EscalationList": {
            "escalationList": [
              {
                "Value": "400",
                "MetricName": "HttpStatus",
                "Operator": "=",
                "Times": "3",
                "Aggregate": "Value"
              }
            ]
          },
          "TargetList": {
            "Target": [
              {
                "Id": "1",
                "Arn": "acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages",
                "Level": "INFO",
                "JsonParams": "{\"key1\":\"value1\"}"
              }
            ]
          }
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

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

変更履歴

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