すべてのプロダクト
Search
ドキュメントセンター

Auto Scaling:ModifyLifecycleHook

最終更新日:Nov 02, 2026

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

操作説明

操作の説明

変更済みのライフサイクルフックは、以下のいずれかの方法で指定できます。

  • ライフサイクルフック 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

任意

待機状態の終了後に実行される操作。有効な値:

  • CONTINUE: スケールアウトまたはスケールインアクティビティへの応答を続行します。

  • ABANDON: スケールアウトアクティビティ中に作成された ECS インスタンスをリリースするか、スケールインアクティビティ中にスケーリンググループから ECS インスタンスを削除します。

  • ROLLBACK: ECS インスタンスのリリースを拒否し、スケールインアクティビティをロールバックします。スケールアウトアクティビティの場合、この値は ABANDON と同じ効果を持ち、作成された ECS インスタンスがリリースされます。

スケーリンググループでスケールインアクティビティ (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****"
}

エラーコード

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

変更履歴

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