すべてのプロダクト
Search

このプロダクト

    Auto Scaling:StartInstanceRefresh

    ドキュメントセンター

    Auto Scaling:StartInstanceRefresh

    最終更新日:Jun 16, 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 文字です。形式要件：英数字 ([0-9a-zA-Z]) とアンダースコア (_) を使用できます。数字で始めることはできません。

    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

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストID。

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

    string

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

    ir-a12ds234fasd*****

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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