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

Auto Scaling:DescribeInstanceRefreshes

最終更新日:Sep 17, 2026

スケーリンググループのインスタンスリフレッシュタスクの基本情報と進行状況を含む詳細を照会します。

今すぐお試しください

この 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:DescribeInstanceRefreshes

get

*ScalingGroup

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

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

cn-hangzhou

NextToken

string

任意

ページネーショントークン。このパラメーターには、前の呼び出しで返された NextToken 値を設定します。最初のリクエストでは、このパラメーターを設定する必要はありません。

caeba0bbb2be03f84eb48b699f0a****

MaxResults

integer

任意

ページングクエリにおける 1 ページあたりのエントリの最大値。有効な値: 1~50。デフォルト値: 10。

10

ScalingGroupId

string

必須

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

asg-bp1ffogfdauy0jw0****

InstanceRefreshTaskId

array

任意

クエリするインスタンスリフレッシュタスクの ID。

string

任意

クエリするインスタンスリフレッシュタスクの ID。N の有効な値: 1~20。

ir-adfa12312*****

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

NextToken

string

次のクエリのページネーショントークン。NextToken が空の場合、それ以上の結果はありません。

caeba0bbb2be03f84eb48b699f****

MaxResults

integer

1 ページあたりのエントリの最大値。

50

TotalCount

integer

インスタンスリフレッシュタスクの総数。

100

InstanceRefreshTasks

object

InstanceRefreshTask

array<object>

インスタンスリフレッシュタスクのリスト。

array<object>

インスタンスリフレッシュタスク。

InstanceRefreshTaskId

string

インスタンスリフレッシュタスクの ID。

ir-1adfa123****

ScalingGroupId

string

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

asg-bp16pbfcr8j9*****

RegionId

string

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

cn-hangzhou

EndTime

string

インスタンスリフレッシュタスクの終了時刻。

2024-08-22T02:09:00Z

StartTime

string

インスタンスリフレッシュタスクの開始時刻。

2024-08-22T01:09:00Z

Status

string

インスタンスリフレッシュタスクの現在のステータス。有効な値:

  • Pending: インスタンスリフレッシュタスクが作成され、スケジュール待ちの状態です。

  • InProgress: インスタンスリフレッシュタスクが進行中です。

  • Paused: インスタンスリフレッシュタスクが一時停止されています。

  • CheckpointPause: タスクの進行状況がチェックポイント (Checkpoint.Percentage) に達したため、インスタンスリフレッシュタスクが一時停止されています。

  • Failed: インスタンスリフレッシュタスクが失敗しました。

  • Successful: インスタンスリフレッシュタスクが成功しました。

  • Cancelling: インスタンスリフレッシュタスクがキャンセル中です。

  • Cancelled: インスタンスリフレッシュタスクがキャンセルされました。

  • RollbackInProgress: インスタンスリフレッシュタスクがロールバック中です。

  • RollbackSuccessful: インスタンスリフレッシュタスクがロールバックされました。

  • RollbackFailed: インスタンスリフレッシュタスクのロールバックが失敗しました。

InProgress

Detail

string

インスタンスリフレッシュタスクが失敗した場合の具体的な失敗理由。

タスクの実行時間が最大値の 1 週間を超えたため、タスクは失敗した。

MinHealthyPercentage

integer

インスタンスリフレッシュ中にスケーリンググループ内でサービスを提供し続ける必要があるインスタンスの割合の最小値。

80

MaxHealthyPercentage

integer

インスタンスリフレッシュ中にスケーリンググループ内のインスタンス数がスケーリンググループの容量を超えることができる割合の最大値。

120

DesiredConfiguration

object

インスタンスリフレッシュの希望する構成。

ImageId

string

インスタンスの自動作成に使用されるイメージファイルの ID。

m-uf6g5noisr****

ScalingConfigurationId

string

スケーリング設定の ID。

asc-wz91ibkhfor****

LaunchTemplateId

string

スケーリンググループが起動構成情報を取得するために使用する起動テンプレートの ID。

lt-2ze5x4mp*****

LaunchTemplateVersion

string

起動テンプレートのバージョン。有効な値:

  • 固定のテンプレートバージョン番号。

  • Default: 常にテンプレートのデフォルトバージョンを使用します。

  • Latest: 常にテンプレートの最新バージョンを使用します。

Latest

LaunchTemplateOverrides

object

LaunchTemplateOverride

array<object>

起動テンプレートを拡張するインスタンスタイプ情報。

object

起動テンプレートを拡張するインスタンスタイプ情報。

InstanceType

string

起動テンプレート内のインスタンスタイプを上書きする、指定されたインスタンスタイプ。

ecs.g7.2xlarge

Containers

object

Container

array<object>

インスタンスに含まれるコンテナのリスト。

array<object>

インスタンスに含まれるコンテナのリスト。

Name

string

カスタムコンテナ名。

name

Image

string

コンテナイメージ。

registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest

Commands

object

Command

array

コンテナの起動コマンド。

string

コンテナの起動コマンド。

sleep

EnvironmentVars

object

EnvironmentVar

array<object>

環境変数情報。

object

環境変数情報。

Key

string

環境変数の名前。

PATH

Value

string

環境変数の値。

/usr/local/bin

FieldRefFieldPath

string

説明

このパラメーターは使用できません。

fieldPath

Args

object

Arg

array

コンテナ起動コマンドの引数。

string

コンテナ起動コマンドの引数。

100

FinishedUpdateCapacity

integer

リフレッシュされた容量。

10

TotalNeedUpdateCapacity

integer

リフレッシュが必要な合計容量。

20

SkipMatching

boolean

希望する構成に一致するインスタンスをスキップするかどうかを指定します。

説明

システムは、特定の構成項目を比較するのではなく、希望するスケーリング設定の ID に基づいてインスタンスが一致するかどうかを判断します。

有効な値:

  • true: スキップします。インスタンスリフレッシュタスクの開始時に、システムは各インスタンスの構成を確認します。すでに希望する構成で作成されたインスタンスはリフレッシュされません。

  • false: スキップしません。インスタンスリフレッシュタスクの開始後、スケーリンググループ内のすべてのインスタンスがリフレッシュされます。

true

CheckpointPauseTime

integer

チェックポイントに達したときにタスクが一時停止する持続時間。単位: 分。

30

Checkpoints

object

Checkpoint

array<object>

リフレッシュタスクのチェックポイント。インスタンスリフレッシュ中に新しいインスタンスの割合が指定された値に達したときに、タスクが CheckpointPauseTime 分間自動的に一時停止することを指定します。

object

リフレッシュタスクのチェックポイント。インスタンスリフレッシュ中に新しいインスタンスの割合が指定された値に達したときに、タスクが CheckpointPauseTime 分間自動的に一時停止することを指定します。

Percentage

integer

スケーリンググループ内の合計インスタンス数に対する新しいインスタンスの割合。この割合に達すると、タスクは自動的に一時停止します。

60

Strategy

string

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "NextToken": "caeba0bbb2be03f84eb48b699f****",
  "MaxResults": 50,
  "TotalCount": 100,
  "InstanceRefreshTasks": {
    "InstanceRefreshTask": [
      {
        "InstanceRefreshTaskId": "ir-1adfa123****",
        "ScalingGroupId": "asg-bp16pbfcr8j9*****",
        "RegionId": "cn-hangzhou",
        "EndTime": "2024-08-22T02:09:00Z",
        "StartTime": "2024-08-22T01:09:00Z",
        "Status": "InProgress",
        "Detail": "The task exceeded its maximum run time of one week. So the task failed.",
        "MinHealthyPercentage": 80,
        "MaxHealthyPercentage": 120,
        "DesiredConfiguration": {
          "ImageId": "m-uf6g5noisr****",
          "ScalingConfigurationId": "asc-wz91ibkhfor****",
          "LaunchTemplateId": "lt-2ze5x4mp*****",
          "LaunchTemplateVersion": "Latest",
          "LaunchTemplateOverrides": {
            "LaunchTemplateOverride": [
              {
                "InstanceType": "ecs.g7.2xlarge"
              }
            ]
          },
          "Containers": {
            "Container": [
              {
                "Name": "name",
                "Image": "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest",
                "Commands": {
                  "Command": [
                    "sleep"
                  ]
                },
                "EnvironmentVars": {
                  "EnvironmentVar": [
                    {
                      "Key": "PATH",
                      "Value": "/usr/local/bin",
                      "FieldRefFieldPath": "fieldPath"
                    }
                  ]
                },
                "Args": {
                  "Arg": [
                    "100"
                  ]
                }
              }
            ]
          }
        },
        "FinishedUpdateCapacity": 10,
        "TotalNeedUpdateCapacity": 20,
        "SkipMatching": true,
        "CheckpointPauseTime": 30,
        "Checkpoints": {
          "Checkpoint": [
            {
              "Percentage": 60
            }
          ]
        },
        "Strategy": ""
      }
    ]
  }
}

エラーコード

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

変更履歴

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