スケーリンググループに 1 つ以上のライフサイクルフックを作成します。ライフサイクルフックを使用すると、インスタンスのライフサイクルにおける重要な段階 (インスタンスの起動や終了など) で、通知の送信やスクリプト実行の自動化などのカスタムアクションを実行できます。ライフサイクルフック機能を実装することで、インスタンスをより細かく制御および管理できるようになります。たとえば、ライフサイクルフックが有効になっているときに、インスタンスの設定を検証したり、カスタムタスクを設定したり、データをバックアップしたりすることで、アプリケーションデプロイの柔軟性と信頼性を向上させることができます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ess:CreateLifecycleHook |
create |
*ScalingGroup
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ScalingGroupId |
string |
必須 |
スケーリンググループの ID。 |
asg-bp1eyv4qn8ssgv43**** |
| LifecycleHookName |
string |
任意 |
ライフサイクルフックの名前。各ライフサイクルフック名は、スケーリンググループ内で一意である必要があります。名前は 2 ~ 64 文字で、英字、数字、アンダースコア (_)、ハイフン (-)、ピリオド (.) を含めることができます。英字または数字で始まる必要があります。 このパラメータを指定しない場合、LifecycleHookId パラメータの値を使用します。 |
lifecyclehook**** |
| LifecycleTransition |
string |
必須 |
ライフサイクルフックが適用されるスケーリングアクティビティのタイプ。有効な値は次のとおりです:
|
SCALE_OUT |
| DefaultResult |
string |
任意 |
ライフサイクルフックがタイムアウトした後に Auto Scaling が実行するアクション。有効な値は次のとおりです:
スケーリンググループ内の複数のライフサイクルフックがスケールインアクティビティ中にトリガーされ、いずれかのライフサイクルフックの DefaultResult パラメータを ABANDON に設定した場合、Auto Scaling は、DefaultResult が ABANDON に設定されているライフサイクルフックがタイムアウトした直後にアクションを実行します。その結果、他のライフサイクルフックは予定より早くタイムアウトします。それ以外の場合、Auto Scaling は、すべてのライフサイクルフックがタイムアウトした後にのみアクションを実行します。 デフォルト値: CONTINUE。 |
CONTINUE |
| HeartbeatTimeout |
integer |
任意 |
ライフサイクルフックがタイムアウトするまでの期間。ライフサイクルフックがタイムアウトすると、Auto Scaling はデフォルトのアクションを実行します。有効な値: 30 ~ 21600。単位: 秒。 ライフサイクルフックを作成した後、RecordLifecycleActionHeartbeat API を呼び出してライフサイクルフックのタイムアウト期間を延長できます。また、CompleteLifecycleAction API を呼び出して、ライフサイクルフックのタイムアウト期間を予定より早く終了することもできます。 デフォルト値: 600。 |
600 |
| NotificationMetadata |
string |
任意 |
ライフサイクルフックが有効になったときに送信される通知メタデータ。これにより、通知を効率的に管理および分類できます。このパラメータを指定する場合は、NotificationArn パラメータを指定する必要があります。値は 4,096 文字以内である必要があります。 NotificationArn パラメータを使用してパブリックまたはカスタムの OOS テンプレートを指定する場合、NotificationMetadata パラメータの値は、OOS テンプレートパラメータを含む JSON 文字列である必要があります。たとえば、OOS テンプレートに次のパラメータが含まれているとします:
説明
テンプレートパラメータ情報は、[OOS コンソール]で取得できます。 |
Test lifecycle hook. |
| NotificationArn |
string |
任意 |
通知の受信者の Alibaba Cloud Resource Name (ARN)。このパラメータを指定しない場合、ライフサイクルフックが有効になったときに通知は送信されません。このパラメータを指定する場合、値は、次のいずれかの形式で指定する必要があります:
上記の値形式における各変数の意味は、次のとおりです:
|
acs:mns:cn-beijing:161456884340****:queue/modifyLifecycleHo**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストの ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| LifecycleHookId |
string |
ライフサイクルフックの ID。 |
ash-bp1at9ufhmcf9cmy**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"LifecycleHookId": "ash-bp1at9ufhmcf9cmy****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。