RecordLifecycleActionHeartbeat - Auto Scaling - Alibaba Cloud ドキュメントセンター

Elastic Compute Service (ECS) インスタンスが待機状態であるタイムウィンドウを延長します。現在のタイムウィンドウが、ECS インスタンス上でカスタム操作を完了するのに十分でない場合は、RecordLifecycleActionHeartbeat API を呼び出してタイムウィンドウを延長できます。この API を呼び出す際、lifecycleHookId、lifecycleActionToken、および heartbeatTimeout を指定して、対象の ECS インスタンスのタイムウィンドウを延長できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ess:RecordLifecycleActionHeartbeat

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
lifecycleHookId	string	必須	ライフサイクルフックの ID。	ash-bp1fxuqyi98w0aib****
lifecycleActionToken	string	必須	ライフサイクルフックのアクショントークン。ライフサイクルフックに指定された Simple Message Queue (SMQ、旧 MNS) キューの詳細ページからトークンを取得できます。 DescribeLifecycleActions API を呼び出して、ライフサイクルフックのアクショントークンを取得することもできます。ライフサイクルフックに SMQ トピックを指定した場合は、MNS トピックからトークンを取得できます。	F324B880-900E-4968-85DD-81691113****
heartbeatTimeout	integer	任意	ECS インスタンスが待機状態であるタイムウィンドウ。このタイムウィンドウが終了すると、Auto Scaling はデフォルトのアクションを実行します。有効な値：30～21600。単位：秒。ライフサイクルフックを作成した後、この API を呼び出して、ECS インスタンスの待機タイムウィンドウを延長できます。また、CompleteLifecycleAction API を呼び出して、ECS インスタンスの待機状態を予定より早く終了させることもできます。デフォルト値：600。	600
RegionId	string	任意	スケーリンググループが属するリージョン ID。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

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

変更履歴

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