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

Auto Scaling:DescribeLifecycleHooks

最終更新日:Nov 02, 2026

ライフサイクルフック ID またはスケーリンググループ ID を指定して、ライフサイクルフックの詳細を照会します。詳細には、待機状態の終了後に実行する次の操作、ライフサイクルフックに関連付けられたスケーリングアクティビティのタイプ、通知の受信者の識別子、および中断待機時間が含まれます。

操作説明

操作の説明

ライフサイクルフックは、次の 3 つの方法でクエリできます。

  • ライフサイクルフック ID のリスト (LifecycleHookId.N) を指定します。この場合、ScalingGroupId パラメーターと LifecycleHookName パラメーターは無視されます。

  • スケーリンググループ ID (ScalingGroupId) を指定します。

  • スケーリンググループ 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:DescribeLifecycleHooks

get

*ScalingGroup

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

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

ScalingGroupId

string

任意

スケーリンググループの ID。

asg-bp1igpak5ft1flyp****

LifecycleHookName

string

任意

ライフサイクルフックの名前。

lifecyclehook****

PageNumber

integer

任意

インスタンスステータスリストのページ番号。ページは 1 から始まります。

デフォルト値: 1。

1

PageSize

integer

任意

ページングクエリ中に各ページで返すエントリ数。最大値: 50。

デフォルト値: 50。

50

LifecycleHookId

array

任意

ライフサイクルフック ID のリスト。

ash-bp19d1032y9kij96****

string

任意

ライフサイクルフックの ID。

ash-bp1at9ufhmcf9cmy****

RegionId

string

任意

スケーリンググループのリージョン ID。

cn-beijing

レスポンスフィールド

フィールド

型

説明

例

object

LifecycleHooks

object

LifecycleHook

array<object>

ライフサイクルフックのリスト。

array<object>

ライフサイクルフックの詳細。

DefaultResult

string

中断されたインスタンスの待機状態が終了した後に実行する次の操作。

CONTINUE

HeartbeatTimeout

integer

スケーリングアクティビティに対してライフサイクルフックで設定された待機時間。待機時間の経過後に次の操作が実行されます。

60

LifecycleActionSources

object

LifecycleActionSource

array

ライフサイクルフックをトリガーする特定のシナリオ。

string

ライフサイクルフックをトリガーする特定のシナリオ。有効な値:

  • DirectToScalingGroup: スケールアウト時にインスタンスがスケーリンググループに直接追加されます。

  • DirectToWarmPool: スケールアウト時にインスタンスがウォームプールに追加されます。

  • WarmPoolToScalingGroup: スケールアウト時にインスタンスがウォームプールからスケーリンググループに追加されます。

  • ScalingGroupToTerminate: スケールイン時にインスタンスがスケーリンググループから直接削除され、リリースされます。

  • WarmPoolToTerminate: スケールイン時にインスタンスがウォームプールから直接削除され、リリースされます。

  • ScalingGroupToWarmPool: スケールイン時にインスタンスがスケーリンググループから削除され、ウォームプールに回収されます。

DirectToScalingGroup

LifecycleHookId

string

ライフサイクルフックの ID。

ash-bp19d1032y9kij96****

LifecycleHookName

string

ライフサイクルフックの名前。

lifecyclehook****

LifecycleHookStatus

string

ライフサイクルフックのステータス。有効な値:

  • Active: 有効。

  • InActive: 一時停止。

Active

LifecycleTransition

string

ライフサイクルフックに関連付けられたスケーリングアクティビティのタイプ。

SCALE_OUT

NotificationArn

string

ライフサイクルフックの通知の受信者の識別子。パラメーターのフォーマットは次のとおりです。

  • 通知が設定されていない場合: acs:ess:{region-id}:{account-id}:null/null。

  • メッセージサービス (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/デフォルト。

パラメーターフォーマットの変数の意味は次のとおりです。

  • region-id: スケーリンググループが存在するリージョンの ID。

  • account-id: Alibaba Cloud アカウント ID。

  • queuename: MNS キューの名前。

  • topicname: MNS トピックの名前。

  • templatename: OOS テンプレートの名前。

acs:ess:cn-beijing:161456884340****:null/null

NotificationMetadata

string

スケーリングアクティビティの待機状態の固定フォーマット文字列情報。

Test Lifecycle Hook.

ScalingGroupId

string

スケーリンググループの ID。

asg-bp1igpak5ft1flyp****

PageNumber

integer

ページ番号。

1

PageSize

integer

各ページで返されるエントリ数。

50

RequestId

string

リクエスト ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

TotalCount

integer

ライフサイクルフックの総数。

1

例

成功レスポンス

JSONJSON

{
  "LifecycleHooks": {
    "LifecycleHook": [
      {
        "DefaultResult": "CONTINUE",
        "HeartbeatTimeout": 60,
        "LifecycleActionSources": {
          "LifecycleActionSource": [
            "DirectToScalingGroup"
          ]
        },
        "LifecycleHookId": "ash-bp19d1032y9kij96****",
        "LifecycleHookName": "ライフサイクルフック****",
        "LifecycleHookStatus": "Active",
        "LifecycleTransition": "SCALE_OUT",
        "NotificationArn": "acs:ess:cn-beijing:161456884340****:null/null",
        "NotificationMetadata": "Test Lifecycle Hook",
        "ScalingGroupId": "asg-bp1igpak5ft1flyp****"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1
}

エラーコード

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

変更履歴

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