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

ライフサイクルフックのアクションを照会します。DescribeLifecycleActions API を呼び出す際に、ScalingActivityId、NextToken、MaxResults などのパラメーターを指定して、ライフサイクルフックのアクションステータスや ID などの詳細を照会できます。また、この API を呼び出して、ライフサイクルフックが適用される Elastic Compute Service (ECS) インスタンスの 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:DescribeLifecycleActions

get

*ScalingGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ScalingActivityId	string	必須	スケーリングアクティビティの ID。	asa-bp17mug9t0pegagw****
LifecycleActionStatus	string	任意	ライフサイクルアクションのステータス。有効な値：ライフサイクルアクションが保留中状態の場合、ECS インスタンスはスケーリンググループへの追加、またはスケーリンググループからの削除を待機しています。ライフサイクルアクションがタイムアウト状態の場合、ライフサイクルアクションをトリガーしたライフサイクルフックは終了し、ECS インスタンスはスケーリンググループに追加または削除されます。ライフサイクルアクションが完了状態の場合、ライフサイクルアクションをトリガーしたライフサイクルフックは手動で早期に終了されています。	Pending
NextToken	string	任意	クエリを開始するライフサイクルアクションを指定するために使用するトークン。たとえば、最初の 10 件のライフサイクルアクションがクエリされた後、クエリは 11 件目のライフサイクルアクションから開始されます。このパラメーターを、前の API 呼び出しで返された NextToken 値に設定します。このパラメーターを指定しない場合、クエリは最初から開始されます。	AAAAAcSz4VTb1Nq****
MaxResults	integer	任意	1 ページあたりに返される最大エントリ数。有効な値：1～50。デフォルト値：10。	10
RegionId	string	任意	スケーリンググループが属するリージョン ID。	cn-qingdao

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	今回の呼び出しで返されたクエリトークン。	AAAAAcSz4VTb1Nq****
RequestId	string	リクエスト ID。	42A742EB-FCF3-459E-9C62-E107048C17E3
TotalCount	integer	クエリされたライフサイクルアクションの総数。	3
MaxResults	integer	1 ページあたりに返される最大エントリ数。	3
LifecycleActions	array<object>	ライフサイクルフックのアクション。
	object	ライフサイクルアクション。
LifecycleHookId	string	ライフサイクルフックの ID。	ash-bp18uoft0deax0f7****
LifecycleActionToken	string	ライフサイクルフックアクションのトークン。	9C2E9DA7-F794-449A-ACF6-CEE24444F7BB
LifecycleActionStatus	string	ライフサイクルフックアクションのステータス。	Pending
LifecycleActionResult	string	ライフサイクルフックがタイムアウトした後に Auto Scaling (ESS) が実行するアクション。有効な値： CONTINUE：Auto Scaling (ESS) は、スケールインまたはスケールアウトのリクエストへの応答を続行します。 ABANDON：Auto Scaling (ESS) は、スケールアウトイベント中に作成された ECS インスタンスを解放するか、スケールインイベント中にスケーリンググループから ECS インスタンスを削除します。	CONTINUE
InstanceIds	array	ライフサイクルフックが適用される ECS インスタンスの ID。
	string	ライフサイクルフックが適用される ECS インスタンスの ID。	["i-bp11m3fzlqrgk5vh**","i-bp11m3fzlqrgk5vh**"]

例

成功レスポンス

JSONJSON

{
  "NextToken": "AAAAAcSz4VTb1Nq****",
  "RequestId": "42A742EB-FCF3-459E-9C62-E107048C17E3",
  "TotalCount": 3,
  "MaxResults": 3,
  "LifecycleActions": [
    {
      "LifecycleHookId": "ash-bp18uoft0deax0f7****",
      "LifecycleActionToken": "9C2E9DA7-F794-449A-ACF6-CEE24444****",
      "LifecycleActionStatus": "Pending",
      "LifecycleActionResult": "CONTINUE",
      "InstanceIds": [
        "[\"i-bp11m3fzlqrgk5vh****\",\"i-bp11m3fzlqrgk5vh****\"]"
      ]
    }
  ]
}

エラーコード

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

変更履歴

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