すべてのプロダクト
Search

このプロダクト

    Auto Scaling:StartInstanceRefresh

    ドキュメントセンター

    Auto Scaling:StartInstanceRefresh

    最終更新日:Jul 08, 2026

    スケーリンググループに新しいスケーリング設定を適用する場合、またはスケーリンググループ内のインスタンスのイメージを更新する場合に、スケーリンググループ内のインスタンスをリフレッシュします。

    操作説明

    • スケーリンググループ内で一度に実行できるインスタンスリフレッシュノードは 1 つだけです。

    • この特徴は、スケールアウトポリシーが 優先度ポリシー にセットされている ECS スケーリンググループのみでサポートされます。vCPU ベースの容量計算 を使用するスケーリンググループ、およびインスタンス取り消しパターンが シャットダウンして取り消すパターン または 強制シャットダウンして取り消すパターン にセットされているスケーリンググループでは、この特徴はサポートされません。

    • インスタンスのリフレッシュ中は、通常のスケールアウトおよびスケールイン操作を実行できます。ただし、スケールアウト操作ではインスタンスリフレッシュの希望する構成が使用されます。

    • スケーリンググループに手動で追加されたインスタンス、スタンバイ状態のインスタンス、および保護ステータスのインスタンスは、インスタンスリフレッシュノードによって無視され、インスタンスリフレッシュには参加しません。

    今すぐお試しください

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

    update

    *ScalingGroup

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ScalingGroupId

    string

    必須

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

    asg-bp18p2yfxow2dloq****
    ClientToken

    string

    任意

    リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。

    123e4567-e89b-12d3-a456-42665544****
    RegionId

    string

    必須

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

    cn-hangzhou
    MinHealthyPercentage

    integer

    任意

    インスタンスリフレッシュ中にスケーリンググループ内でサービスを提供し続ける必要があるインスタンスの最小値のパーセント値。有効な値: 0～100。 デフォルト値: 80。

    80
    MaxHealthyPercentage

    integer

    任意

    インスタンスリフレッシュ中にスケーリンググループ内のインスタンス数がスケーリンググループの容量を超えられる最大値のパーセント値。有効な値: 100～200。 デフォルト値: 120。

    説明

    MinHealthyPercentage = MaxHealthyPercentage = 100 の場合、一度に 1 つのインスタンスがリフレッシュされます。

    100
    DesiredConfiguration

    object

    任意

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

    説明

    • ScalingConfigurationId、ImageId、LaunchTemplateId、Containers を同時に指定することはできません。このパラメーターが空の場合、スケーリンググループの現在アクティブな構成がリフレッシュに使用されます。

    • インスタンスリフレッシュタスクの完了後、スケーリンググループのアクティブなスケーリング設定がこの構成に更新されます。

    ImageId

    string

    任意

    イメージの ID。

    説明

    • インスタンスリフレッシュタスクの完了後、スケーリンググループの現在アクティブな構成内のイメージがこのイメージに更新されます。

    • スケーリンググループのインスタンス構成ソースが起動テンプレートの場合、このパラメーターはサポートされません。

    • データクラウドディスクを含むイメージはサポートされていません。

    m-2ze8cqacj7opnf***
    ScalingConfigurationId

    string

    任意

    スケーリング設定の ID。

    asc-2zed7lqn4ts4****
    LaunchTemplateId

    string

    任意

    起動テンプレートの ID。このパラメーターは、スケーリンググループが起動テンプレートから起動構成情報を取得することを指定します。

    lt-2ze2qli30u***
    LaunchTemplateVersion

    string

    任意

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

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

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

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

    説明

    バージョンが Default または Latest に設定されている場合、インスタンスリフレッシュタスクのロールバックはサポートされません。

    8
    LaunchTemplateOverrides

    array<object>

    任意

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

    object

    任意

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

    InstanceType

    string

    任意

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

    説明

    このパラメーターは、LaunchTemplateId パラメーターで起動テンプレートが指定されている場合にのみ効果が有効です。

    ecs.c5.2xlarge
    Containers

    array<object>

    任意

    インスタンス内のコンテナのリスト。

    説明

    • このパラメーターは、Elastic Container Instance (ECI) スケーリンググループでのみサポートされます。

    • 現在のスケーリング設定のコンテナリスト内の Container.Name と名前が一致するコンテナ構成のみがリフレッシュされます。

    array<object>

    任意

    インスタンス内のコンテナのリスト。

    Name

    string

    任意

    カスタムコンテナ名。

    nginx
    Image

    string

    任意

    コンテナイメージ。

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

    array

    任意

    コンテナの起動コマンド。最大値は 20 個のコマンドです。各コマンドの長さは最大 256 文字です。

    string

    任意

    コンテナの起動コマンド。最大値は 20 個のコマンドです。各コマンドの長さは最大 256 文字です。

    sleep
    Args

    array

    任意

    コンテナ起動コマンドの引数。最大値は 10 個の引数です。

    string

    任意

    コンテナ起動コマンドの引数。最大値は 10 個の引数です。

    100
    EnvironmentVars

    array<object>

    任意

    環境変数情報。

    object

    任意

    環境変数情報。

    Key

    string

    任意

    環境変数の名前。名前は1～128 文字で、数字、英字、アンダースコア（_）を含めることができます。数字で始めることはできません。

    PATH
    Value

    string

    任意

    環境変数の値。値は0～256 文字です。

    /usr/local/bin

    FieldRefFieldPath

    string

    任意

    説明

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

    fieldPath
    SkipMatching

    boolean

    任意

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

    説明

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

    有効な値:

    • true: 希望する構成で作成済みのインスタンスはスキップされます。

    • false: リフレッシュタスクの開始時にスケーリンググループ内に存在するすべてのインスタンスがリフレッシュされます。

    デフォルト値: true。

    true
    Checkpoints

    array<object>

    任意

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

    object

    任意

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

    Percentage

    integer

    任意

    タスクが自動的に一時停止される、スケーリンググループ内の全インスタンスに対する新しいインスタンスのパーセント値。有効な値: 1～100 (%)。

    説明

    値は昇順の注文で指定する必要があり、最後のパーセント値は 100 である必要があります。

    20
    CheckpointPauseTime

    integer

    任意

    チェックポイントに達したときにタスクが一時停止される持続時間。

    • 単位: 分。

    • 有効な値: 1～2880。

    • デフォルト値: 60。

    10
    Strategy

    string

    任意

    インスタンスリフレッシュタスクの実行戦略。有効な値:

    • Rolling: インスタンスリフレッシュタスクは、新しいインスタンスを作成し、古いインスタンスをリリースしてインスタンスをリフレッシュします。

    • ReplaceSystemDisk: DesiredConfiguration.image を指定して既存のインスタンスのシステムクラウドディスクを置き換え、システムクラウドディスクを更新します。

    デフォルト値: Rolling。

    Rolling

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    string

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

    ir-a12ds234fasd*****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InstanceRefreshTaskId": "ir-a12ds234fasd*****"
}

    エラーコード

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

    変更履歴

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