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

ライフサイクルフックの情報を変更します。

操作説明

操作の説明

変更するライフサイクルフックを以下のいずれかの方法で指定できます:

ライフサイクルフック ID (LifecycleHookId) のみを指定します。スケーリンググループ ID (ScalingGroupId) およびライフサイクルフック名 (LifecycleHookName) パラメーターは無視されます。
スケーリンググループ ID (ScalingGroupId) とライフサイクルフック名 (LifecycleHookName) の両方を指定します。ライフサイクルフック名はスケーリンググループ内で一意であるためです。

今すぐお試しください

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

update

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
LifecycleHookId	string	任意	変更するライフサイクルフックの ID。このパラメーターはライフサイクルフックを指定するために使用されます。	ash-bp1fxuqyi98w0aib****
ScalingGroupId	string	任意	スケーリンググループの ID。このパラメーターはライフサイクルフックを指定するために使用されます。	asg-bp18p2yfxow2dloq****
LifecycleHookName	string	任意	変更するライフサイクルフックの名前。このパラメーターはライフサイクルフックを指定するために使用されます。	test_SCAL****
DefaultResult	string	任意	ライフサイクルフックがタイムアウトしたときに Auto Scaling が実行する操作。有効な値: CONTINUE: Auto Scaling はスケールアウトまたはスケールインアクティビティへの応答を続行します。 ABANDON: Auto Scaling はスケールアウトアクティビティ中に作成された ECS インスタンスをリリースするか、スケールインアクティビティ中にスケーリンググループから ECS インスタンスを削除します。 ROLLBACK: スケールインアクティビティの場合、Auto Scaling は ECS インスタンスのリリースを拒否し、ロールバックを実行します。スケールアウトアクティビティの場合、Auto Scaling は作成された ECS インスタンスをリリースします。これは ABANDON と同じ効果です。スケーリンググループでスケールインアクティビティ (SCALE_IN) が発生し、複数のライフサイクルフックがトリガーされた場合、ライフサイクルフックの DefaultResult が ABANDON または ROLLBACK にセットされており、そのフックの待機状態が終了した時点で、他のライフサイクルフックの待機状態も早期に終了します。それ以外の場合、操作は待機状態が最後に終了するライフサイクルフックによって決定されます。	CONTINUE
HeartbeatTimeout	integer	任意	ライフサイクルフックがスケーリングアクティビティに設定する待機時間。待機状態がタイムアウトすると、デフォルトの操作が実行されます。有効な値: 30～21600。単位: 秒。 RecordLifecycleActionHeartbeat を呼び出して ECS インスタンスの待機時間を延長するか、 CompleteLifecycleAction を呼び出してスケーリングアクティビティの待機状態を早期に終了できます。	600
LifecycleTransition	string	任意	ライフサイクルフックが適用されるスケーリングアクティビティのタイプ。有効な値: SCALE_OUT: スケーリンググループのスケールアウトアクティビティ。 SCALE_IN: スケーリンググループのスケールインアクティビティ。	SCALE_IN
NotificationMetadata	string	任意	スケーリングアクティビティの待機状態に関連付けられた固定文字列情報。パラメーター値の長さは 4,096 文字を超えることはできません。 Auto Scaling が通知の受信者にメッセージをプッシュするたびに、指定した NotificationMetadata パラメーター値も送信されます。これにより、異なるカテゴリの通知を管理およびマークできます。NotificationMetadata パラメーターは、NotificationArn パラメーターも指定した場合にのみ有効になります。	Test
NotificationArn	string	任意	ライフサイクルフックの通知の受信者の識別子。このパラメーターは以下の通知方法をサポートしています: メッセージキュー (旧 MNS) キュー: `acs:mns:{region-id}:{account-id}:queue/{queuename}`。メッセージキュー (旧 MNS) トピック: `acs:mns:{region-id}:{account-id}:topic/{topicname}`。 OOS テンプレート: `acs:oos:{region-id}:{account-id}:template/{templatename}`。 EventBridge: `acs:eventbridge:{region-id}:{account-id}:eventbus/default`。パラメーターフォーマットの変数は以下のとおりです: region-id: スケーリンググループのリージョン ID。 account-id: Alibaba Cloud アカウント ID。 queuename: メッセージキュー (旧 MNS) キューの名前。 topicname: メッセージキュー (旧 MNS) トピックの名前。 templatename: OOS テンプレートの名前。	acs:mns:cn-beijing:161456884340**:queue/modifyLifecycleHo**
RegionId	string	任意	スケーリンググループのリージョン ID。	cn-beijing
LifecycleHookStatus	string	任意	ライフサイクルフックを変更するステータス。有効な値: Active: ライフサイクルフックを開始します。 InActive: ライフサイクルフックを一時停止します。このパラメーターを指定しない場合、ライフサイクルフックは現在のステータスを保持します。説明ライフサイクルフックは作成後、デフォルトで Active 状態になります。	Active

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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