すべてのプロダクト
Search

このプロダクト

    Auto Scaling:DescribeLifecycleHooks

    ドキュメントセンター

    Auto Scaling:DescribeLifecycleHooks

    最終更新日:May 21, 2026

    ライフサイクルフックをクエリします。この操作では、ライフサイクルフック ID またはスケーリンググループ ID を指定して、目的のライフサイクルフックの詳細をクエリできます。たとえば、ライフサイクルフックがタイムアウトした後のデフォルトアクション、ライフサイクルフックに対応するスケーリングアクティビティ、通知の受信者の Alibaba Cloud Resource Name (ARN)、ライフサイクルフックの有効期間などです。

    今すぐお試しください

    この 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
    LifecycleHookIds

    array

    任意

    クエリ対象のライフサイクルフックの ID の配列。

    string

    任意

    クエリ対象のライフサイクルフックの ID。

    ash-bp1at9ufhmcf9cmy****
    RegionId

    string

    任意

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

    cn-beijing

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    PageNumber

    integer

    返されるページの番号。

    1
    PageSize

    integer

    1ページあたりのエントリ数。

    50
    TotalCount

    integer

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

    1
    LifecycleHooks

    array<object>

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

    object

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

    DefaultResult

    string

    ライフサイクルフックがタイムアウトした後に実行される次のアクション。

    CONTINUE
    LifecycleHookId

    string

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

    ash-bp19d1032y9kij96****
    LifecycleHookName

    string

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

    lifecyclehook****
    LifecycleTransition

    string

    ライフサイクルフックが適用されるスケーリングアクティビティのタイプ。

    SCALE_OUT
    NotificationMetadata

    string

    ライフサイクルフックが有効になったときに Auto Scaling が送信する通知に含まれる固定文字列。

    Test Lifecycle Hook.
    NotificationArn

    string

    ライフサイクルフックが有効になったときの通知の受信者の ARN。このパラメーターの値は、次のいずれかの形式にする必要があります。

    • 通知ルールを作成しない場合は、値を acs:ess:{region-id}:{account-id}:null/null の形式で指定します。

    • Simple Message Queue (SMQ) キューを通知の受信者として指定する場合は、値を acs:mns:{region-id}:{account-id}:queue/{queuename} の形式で指定します。

    • Simple Message Queue (SMQ) トピックを通知の受信者として指定する場合は、値を 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：Simple Message Queue (SMQ) キューの名前。

    • topicname：Simple Message Queue (SMQ) トピックの名前。

    • templatename：CloudOps Orchestration Service (OOS) テンプレートの名前。

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

    integer

    ライフサイクルフックがタイムアウトするまでの期間。ライフサイクルフックがタイムアウトすると、Auto Scaling は DefaultResult で指定されたアクションを実行します。

    60
    ScalingGroupId

    string

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

    asg-bp1igpak5ft1flyp****
    LifecycleHookStatus

    string

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

    • アクティブ：ライフサイクルフックは有効です。

    • 非アクティブ：ライフサイクルフックは無効です。

    Active

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "LifecycleHooks": [
    {
      "DefaultResult": "CONTINUE",
      "LifecycleHookId": "ash-bp19d1032y9kij96****",
      "LifecycleHookName": "lifecyclehook****",
      "LifecycleTransition": "SCALE_OUT",
      "NotificationMetadata": "Test Lifecycle Hook.",
      "NotificationArn": "acs:ess:cn-beijing:161456884340****:null/null",
      "HeartbeatTimeout": 60,
      "ScalingGroupId": "asg-bp1igpak5ft1flyp****",
      "LifecycleHookStatus": "Active"
    }
  ]
}

    エラーコード

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

    変更履歴

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