Elastic Compute Service:Cloud Assistant イベントのサブスクライブ

イベントの説明

コマンドやスクリプトの実行には時間がかかります。Cloud Assistant のタスクステータスイベントを使用すると、タスクの完了状況を追跡できます。このイベントは、以下の目的で使用できます。

• Cloud Assistant のタスクが失敗または完了したときに通知を受信できます。通知をアラートや後続の操作に使用できます。

• ポーリングは API 呼び出しのクォータを消費します。これを回避するために、イベントサブスクリプションを使用します。

• ロングポーリングプロセス中に発生する可能性のあるアプリケーションのリリースによる中断を防ぎます。イベントを使用すると、ワークフローが簡素化されます。

トリガー条件と制限

トリガー条件： RunCommand または InvokeCommand API を呼び出してタスクを実行すると、Cloud Assistant はタスクのステータスを監視します。タスクが完了すると、タスクステータスイベントが送信されます。

制限：

• Cloud Assistant のタスクステータスイベントは、ECS インスタンス上のタスクが以下のいずれかの最終状態 (InvocationStatus) になったときにのみ送信されます。

  • Aborted： タスクの送信に失敗しました。

  • Success： タスクは成功しました。

  • Failed： タスクは失敗しました。

  • Invalid： タスクの内容が無効です。

  • Timeout： タスクはタイムアウトしました。

  • Cancelled： タスクはキャンセル済みです。

  • Terminated： タスクは終了しました。

• DescribeInvocations および DescribeInvocationResults API は、array<object> フォーマットでデータを返します。ただし、タスクステータスイベントは、複数のタスクではなく、単一のインスタンス上の単一のタスクのステータスを報告します。

イベントフィールド

イベントの説明

Cloud Assistant のハートビートは、インスタンスのオペレーティングシステムのステータスを判断する方法の 1 つです。初回ハートビートは、オペレーティングシステムが起動したタイミングを示します。この情報を使用して、インスタンスの正常性を確認したり、Cloud Assistant コマンドを送信するタイミングを決定したりできます。

DescribeCloudAssistantStatus API をポーリングする代わりに初回ハートビートイベントを使用すると、以下の問題が解決されます。

• DescribeCloudAssistantStatus をポーリングしてステータスが true に変更されたかどうかを確認するのは複雑です。不適切なポーリング間隔は、リクエストが過多になり、スロットリングをトリガーしたり、システムに負担をかけたりする可能性があります。

• インスタンスのオペレーティングシステムの起動時間は大きく異なる場合があります。一部の Windows インスタンスは起動に最大 5 分かかる場合があり、ポーリングの合計期間を制御することが困難です。

• DescribeCloudAssistantStatus が返すステータスには遅延が発生する可能性があります。ハートビートが停止してからステータスが変更されるまでに 2 分の遅延が生じます。これにより、DescribeCloudAssistantStatus がインスタンスの再起動を検出することが困難になります。

トリガー条件と制限

トリガー条件： Cloud Assistant がハートビートを報告するとき、Cloud Assistant クライアントの起動後の最初のハートビートであることを検出すると、最初のハートビートイベントを送信します。

Cloud Assistant のバージョンの制限：

• Windows インスタンス：Cloud Assistant Agent のバージョンは 1.0.0.149 より新しい必要があります。

• Linux インスタンス：Cloud Assistant Agent のバージョンは 1.0.2.569 より新しい必要があります。

古いバージョンの Cloud Assistant は、毎分ハートビートを報告しないか、index フィールドを報告しません。その結果、起動後の最初のハートビートを正確に識別できません。これらの古いバージョンはサポートされていません。

イベントフィールド

イベントの説明

• コマンドを実行すると、最大 24 KB のコマンド出力が保持されます。この制限を超える出力は切り捨てられます。

• 完全な出力を取得したり、出力を永続化したりする場合は、コマンドの実行が最終状態に達したときに出力をObject Storage Service (OSS) パスに配信するように設定できます。

• このイベントは、以下の目的で使用できます。

  • 出力の配信に関する通知と詳細を受信できます。成功通知を受信すると、対応する OSS バケットから出力ファイルをダウンロードできます。これにより、DescribeInvocations API をポーリングして結果を取得する必要がなくなり、効率が向上します。

  • 配信が失敗した場合、イベントから失敗の詳細な理由を取得できます。

トリガー条件と制限

トリガー条件： RunCommand または InvokeCommand API を使用してタスクを実行し、有効な OssOutputDelivery パラメーターを指定すると、タスクが最終状態に達したときにこのイベントが送信されます。

制限：

• イベントは、インスタンス上のタスクが以下のいずれかの最終状態 (InvocationStatus) になったときにのみ送信されます。

  • Aborted： タスクの送信に失敗しました。

  • Success： タスクは成功しました。

  • Failed： タスクは失敗しました。

  • Invalid： タスクの内容が無効です。

  • Timeout： タスクはタイムアウトしました。

  • Cancelled： タスクはキャンセル済みです。

  • Terminated： タスクは終了しました。

Cloud Assistant のバージョンの制限：

• Windows インスタンス：Cloud Assistant Agent のバージョンは 2.1.4.1007 より新しい必要があります。

• Linux インスタンス：Cloud Assistant Agent のバージョンは 2.2.4.1007 より新しい必要があります。

イベントフィールド

イベントの説明

• Cloud Assistant Agent は、デフォルトで 30 分ごとにバージョンのアップグレードを自動的にチェックします。

• アップグレード失敗通知イベントをサブスクライブして、失敗の理由と解決策を迅速に把握できます。これにより、トラブルシューティングが簡素化されます。

イベントフィールドの説明

エラーコードの説明

エラーコードには、プレフィックス AgentUpdateFailure: が付きます。以下の表に、エラーコードの詳細を示します。

イベント JSON のサンプル

{
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234****",
    "source": "acs.ecs",
    "specversion": "1.0",
    "subject": "acs.ecs:cn-hangzhou:123456789098****:215672",
    "time": "2026-02-28T03:30:00+08:00",
    "type": "ecs:CloudAssistant:UpdateFailed",
    "aliyunaccountid": "123456789098****",
    "aliyunpublishtime": "2026-02-28T03:30:01Z",
    "aliyuneventbusname": "default",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "172.25.XX.XX",
    "data": {
        "instanceId": "i-bp114***************",
        "currentVersion": "2.2.3.529",
        "expectedVersion": "2.2.4.1007",
        "errorCode": "AgentUpdateFailure:DownloadPackageFailed:NetworkTimeout",
        "errorInfo": "The aliyun service network is blocked.",
        "occurrenceTime": "2026-02-28T03:30:00Z"
    }
}

イベントの説明

• Cloud Assistant Agent は、デフォルトで 30 分ごとにバージョンのアップグレードを自動的にチェックします。

• アップグレード成功通知イベントをサブスクライブして、アップグレードのステータスを常に把握できます。これにより、トラブルシューティングが簡素化されます。

イベントフィールドの説明

イベント JSON のサンプル

{
    "id": "f1e2d3c4-b5a6-7890-abcd-123456****",
    "source": "acs.ecs",
    "specversion": "1.0",
    "subject": "acs.ecs:cn-hangzhou:123456789098****:215672",
    "time": "2026-02-28T03:30:00+08:00",
    "type": "ecs:CloudAssistant:UpdateCompleted",
    "aliyunaccountid": "123456789098****",
    "aliyunpublishtime": "2026-02-28T03:30:01Z",
    "aliyuneventbusname": "default",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "172.25.XX.XX",
    "data": {
        "instanceId": "i-bp114***************",
        "currentVersion": "2.2.4.1007",
        "occurrenceTime": "2026-02-28T03:30:00Z"
    }
}