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

ライフサイクルフックを変更します。既存のライフサイクルフックがビジネス要件を満たさなくなった場合、ModifyLifecycleHook API を呼び出して、ライフサイクルフックのスケーリングイベント、タイムアウト期間、デフォルトアクションなどの情報を変更できます。ライフサイクルフックを変更する前に、ID、名前、またはスケーリンググループでライフサイクルフックを特定できます。

今すぐお試しください

この 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_SCALE_IN
DefaultResult	string	任意	ライフサイクルフックの終了後に Auto Scaling (ESS) が実行するアクションです。有効な値： CONTINUE: ESS はスケーリングリクエストへの応答を続行します。 ABANDON: ESS は、スケールアウトアクティビティでは作成された Elastic Compute Service (ECS) インスタンスをリリースし、スケールインアクティビティではスケーリンググループから ECS インスタンスを切り離します。スケーリンググループ内の複数のライフサイクルフックがスケールインアクティビティ中にトリガーされ、変更するライフサイクルフックの DefaultResult パラメータを ABANDON に設定した場合、ESS は、変更するライフサイクルフックの終了後、直ちにアクションを実行します。その結果、他のライフサイクルフックは予定より早く終了します。それ以外の場合、ESS はすべてのライフサイクルフックが終了した後にのみアクションを実行します。	CONTINUE
HeartbeatTimeout	integer	任意	ライフサイクルフックのタイムアウト期間です。ESS は、ライフサイクルフックの終了後、指定されたアクションを実行します。有効な値：30～21600。単位：秒。 RecordLifecycleActionHeartbeat API を呼び出して、ライフサイクルフックのタイムアウト期間を延長できます。また、CompleteLifecycleAction API を呼び出して、ライフサイクルフックを予定より早く終了することもできます。	600
LifecycleTransition	string	任意	ライフサイクルフックが適用されるスケーリングアクティビティのタイプです。有効な値： SCALE_OUT SCALE_IN	SCALE_IN
NotificationMetadata	string	任意	通知に含まれる固定文字列です。ESS は、ライフサイクルフックが有効になったときに通知を送信します。このパラメータの値は 4,096 文字以内である必要があります。 ESS は、NotificationMetadata パラメータに指定された値を通知と共に送信します。これにより、通知を分類できます。NotificationMetadata パラメータは、NotificationArn パラメータを指定した後にのみ有効になります。	Test
NotificationArn	string	任意	通知受信者の Alibaba Cloud リソースネーム (ARN) です。次のいずれかの形式で値を指定します。 Simple Message Queue (SMQ、旧 MNS) キューを通知受信者として指定する場合は、acs:mns:{region-id}:{account-id}:queue/{queuename} の形式で値を指定します。 SMQ (旧 MNS) トピックを通知受信者として指定する場合は、acs:mns:{region-id}:{account-id}:topic/{topicname} の形式で値を指定します。 CloudOps Orchestration Service (OOS) テンプレートを通知受信者として指定する場合は、acs:oos:{region-id}:{account-id}:template/{templatename} の形式で値を指定します。イベントバスを通知受信者として指定する場合は、acs:eventbridge:{region-id}:{account-id}:eventbus/default の形式で値を指定します。上記の形式の各変数には、次の意味があります。 region-id: スケーリンググループのリージョン ID です。 account-id: Alibaba Cloud アカウントの ID です。 queuename: SMQ キューの名前です。 topicname: SMQ トピックの名前です。 templatename: OOS テンプレートの名前です。	acs:mns:cn-beijing:161456884340**:queue/modifyLifecycleHo**
RegionId	string	任意	スケーリンググループのリージョン ID です。	cn-beijing
LifecycleHookStatus	string	任意	ライフサイクルフックに設定するステータスです。有効な値： Active Inactive このパラメータを指定しない場合、API の呼び出し後もライフサイクルフックのステータスは変更されません。説明デフォルトでは、ライフサイクルフックは作成後に Active 状態になります。	Active

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスデータ
RequestId	string	リクエストの ID です。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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