この操作では、可用性モニタリングタスクの一覧を照会します。

デバッグ

API Explorer を使用してデバッグを実行できます。 API Explorer を使用することで、さまざまな操作を実行して API の使用を簡素化できます。 たとえば、API の呼び出し、SDK サンプルコードの動的な生成、API の取得をすることができます。

リクエストパラメーター

パラメーター データ型 必須/省略可能 説明
Action String 省略可能 DescribeHostAvailabilityList

実行する操作。 値を DescribeHostAvailabilityList に設定します。

GroupId Long 省略可能 12345

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

Id Long 省略可能 12346

タスクの ID。

PageNumber Integer 省略可能 1

ページの番号。

PageSize Integer 省略可能 10

各ページのレコード数。

TaskName String 省略可能 My test

ルールの名前。

レスポンスパラメーター

パラメーター データ型 説明
Code String 200

ステータスコード。 値が 200 の場合、呼び出しが成功したことを示します。

Message String success

エラーメッセージ。

RequestId String CE26797C-1094-47E6-B651-73AA888F5873

トラブルシューティングのリクエスト ID。

Success Boolean true

呼び出しが成功したかを示します。 値が true の場合、呼び出しが成功したことを示します。 値が false の場合、呼び出しが失敗したことを示します。

TaskList

タスクの一覧。

└AlertConfig

アラートルールの説明。

└EndTime Integer 23

タスクが終了する時刻。

└EscalationList

アラートルールのトリガー条件。

└Aggregate String Value

統計方法。 さまざまなメトリックに対してさまざまな統計方法が使用されます。

  • Httpstatus : 値
  • HttpLatency : 平均
  • TelnetStatus : 値
  • TelnetLatency : 平均
  • PingLostRate : 平均

Value は元の値を示し、ステータスコードなどのメトリックに使用されます。 Average は平均値を示し、レンテイシやパケット損失率などのメトリックに使用されます。

└MetricName String HttpStatus
  • HttpStatus (HTTP ステータス コード)
  • HttpLatency (HTTP リクエストタイムアウト)
  • TelnetStatus (Telnet ステータス コード)
  • TelnetLatency (Telnet リクエストタイムアウト)
  • PingLostRate (ping パケット損失率)) )
└Operator String >

比較演算子。 有効値 : >, >=, <, <=, and =..

└Times String 2

メトリック値がしきい値を連続して超えるとアラートがトリガーされるようにする期間の数値。

└Value String 99

メトリック値のしきい値。

└NotifyType Integer 1

通知の種類。 有効値 :

  • 2 : 電話 + テキストメッセージ + メール + DingTalk チャットボット
  • 1 : テキストメッセージ + メール + DingTalk チャットボット
  • 0 : メール + DingTalk チャットボット
└SilenceTime Integer 86400

トリガー条件が満たされているにも関わらず新しいアラートが送信されないミュート期間。 単位 : 秒 。 既定値 : 86,400 (1 日)

└StartTime Integer 0

開始時刻。 単位 : 時間。 値が 0 の場合、00:00 を示します。

└WebHook String http://www.aliyun.com

URL コールバックアドレス。

└Disabled Boolean false

タスクモニタリングが無効になっているかを示します。 値が true の場合、タスクモニタリングタスクが無効になっていることを示します。 値が false の場合、タスクモニタリングが有効になっていることを示します。

└GroupId Long 12345

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

└GroupName String Name of application group

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

└Id Long 123

タスクの ID。

└Instances i-a2d5q7pm3f123y456

テストを開始するために使用される ECS インスタンスの一覧。

└TaskName String My intranet test

タスクの名前。

└TaskOption

タスクのパラメーターオプション。

└HttpKeyword String ok

HTTP テストで一致するレスポンスのコンテンツ。

└HttpMethod String GET

HTTP テストのメソッド。 有効値 : GET、POST、HEAD 。

└HttpNegative Boolean true
  • true : 指定されたコンテンツが含まれている場合、アラートがトリガーされます。
  • false : 指定されたコンテンツが含まれていない場合、アラートがトリガーされます。
└HttpResponseCharset String UTF-8

HTTP テストのレスポンスの文字セット。

├HttpURI String http://www.aliyun.com

HTTP テストに使用される URI。

└TelnetOrPingHost String ssh.aliyun.com

テストするドメイン名またはアドレス。 このパラメーターは、Ping テストまたは Telnet テストにて必要になります。

└TaskScope String GROUP

タスクのスコープ。 有効値 :

  • INSTANCE : 指定された、1 つ以上のインスタンスに対してタスクが実行されます。
  • GROUP : グループ内のすべての ECS インスタンスに対してタスクが実行されます。
  • GROUP_SPEC_INSTANCEUP_SPEC_INSTANCE : グループ内で指定された、1 つ以上のインスタンス。
└TaskType String HTTP

タスクの種類。 有効値 : PING、TELNET、HTTP。

Total Integer 12

返されるレコードの総数。

リクエスト例


http(s)://[Endpoint]/? Action=DescribeHostAvailabilityList
&<Common request parameters>

通常のレスポンス例

XML形式

<DescribeHostAvailabilityListResponse>
  <NameList>
    <NodeTaskConfig>
      <GroupName>My application group</GroupName>
      <TaskOption>
        <http_method>get</http_method>
        <HttpURI>http://www.aliyun.com</HttpURI>
      </TaskOption>
      <Disabled>false</Disabled>
      <Instances> 
        <Instance>i-a2d5q7pm3f123y***</Instance>
        <Instance>i-a2d5q7pm3f123x***</Instance>
      </Instances> 
      <Id>3</Id>
      <AlertConfig>
        <Escalations>
          <Escalations>
            <Value>400</Value>
            <MetricName>cpu_total</MetricName>
            <Operator>&gt;</Operator>
            <Times>3</Times>
            <Aggregate>Value</Aggregate>
          </escalationList>
          <escalationList>
            <Value>500</Value>
            <MetricName>HttpLatency</MetricName>
            <Operator>&gt;</Operator>
            <Times>3</Times>
            <Aggregate>Average</Aggregate> 
          </escalationList>
        </EscalationList>
        <SilenceTime>86400</SilenceTime> 
        <NotifyType>1</NotifyType>
        <EndTime>24</EndTime>
        <StartTime>0</StartTime>
      </AlertConfig>
      <TaskType>HTTP</TaskType>
      <TaskName>My intranet test task</TaskName>
      <GroupId>12345</GroupId>
      <TaskScope>GROUP</TaskScope>
    </NodeTaskConfig>
  </NameList>
  <RequestId>CE26797C-1094-47E6-B651-73AA888F5873</RequestId>
  <Success>true</Success> 
  <Code>200</Code>
  <Total>3</Total>
</DescribeHostAvailabilityListResponse>

JSON 形式

{
	"NameList":{
		"NodeTaskConfig":[
			{
				"GroupName":"My application group",
				"Disabled":false,
				"TaskOption":{
					"HttpMethod":"GET",
					"Address":"http://www.aliyun.com",
				},
				"Instances":{
					"Instance":[
						"i-a2d5q7pm3f123y***",
						"i-a2d5q7pm3f123x***"
					]
				},
				"Id":123345,
				"AlertConfig":{
					"EscalationList":{
						"escalationList":[
							{
								"Value":"400",
								"MetricName":"HttpStatus",
								"Operator":">",
								"Times":3,
								"Aggregate":"Value"
							},
							{
								"Value":"500",
								"MetricName":"HttpLatency",
								"Operator":">",
								"Times":3,
								"Aggregate":"Average"
							}
						]
					},
					"NotifyType":1,
					"SilenceTime":86400,
					"EndTime":24,
					"StartTime":0
				},
				"TaskName":"My intranet test task",
				"TaskType":"HTTP",
				"TaskScope":"GROUP",
				"GroupId":12345
			}
		]
	},
	"RequestId":"CE26797C-1094-47E6-B651-73AA888F5873",
	"Success":true,
	"Code": "200"
	"Total":3
}

エラーコード

エラー コードを表示