すべてのプロダクト
Search

このプロダクト

    Cloud Monitor:DescribeHostAvailabilityList

    ドキュメントセンター

    Cloud Monitor:DescribeHostAvailabilityList

    最終更新日:Jul 21, 2026

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

    操作説明

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

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Id

    integer

    任意

    可用性モニタリングタスクの ID。

    123456
    Ids

    string

    任意

    複数の可用性モニタリングタスクの ID。複数の ID はコンマ (,) で区切ります。

    123456,345678
    TaskName

    string

    任意

    可用性モニタリングタスクの名前。

    ecs_instance。
    PageNumber

    integer

    任意

    ページ番号。

    最小値: 1。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。

    最小値: 1。デフォルト値: 10。

    10
    GroupId

    integer

    任意

    アプリケーショングループの ID。

    12345

    共通リクエストパラメーターの詳細については、「共通パラメーター」を参照してください。フォーマットに関する詳細も含まれています。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    状態コード。

    説明

    値 200 は成功を示します。

    200
    Message

    string

    エラーメッセージ。

    指定されたリソースが見つかりません。
    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 インスタンスのリスト。

    i-abcdefgh12****
    TaskOption

    object

    可用性モニタリングタスクのパラメーターオプション。

    HttpMethod

    string

    検出タイプの HTTP メソッド。有効な値:

    • GET

    • POST

    • HEAD

    GET
    Interval

    integer

    検出周波数。単位: 秒。

    60
    HttpURI

    string

    HTTP 検出用の URI。

    https://www.aliyun.com
    TelnetOrPingHost

    string

    検出対象のドメイン名またはアドレス。

    ssh.aliyun.com
    HttpResponseCharset

    string

    HTTP 検出の応答文字セット。

    UTF-8
    HttpPostContent

    string

    HTTP 検出リクエストの POST コンテンツ。

    params1=paramsValue1
    HttpNegative

    boolean

    HTTP 応答コンテンツと一致させるアラートルール。有効な値:

    • 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 は 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: HTTP 状態コード。

    • HttpLatency: HTTP 応答時間。

    • TelnetStatus: TELNET 状態コード。

    • TelnetLatency: TELNET 応答時間。

    • PingLostRate: PING パケット損失レート。

    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 Resource Name (ARN)。

    フォーマット: arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}。各フィールドの説明は以下の通りです:

    • Service: Alibaba Cloud サービスのコード。

    • 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.

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

    変更履歴

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