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

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

操作説明

操作の説明

スケーリンググループでは、一度に実行中のインスタンスリフレッシュタスクは 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

*スケーリンググループ。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	スケーリンググループのリージョン ID。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを使用でき、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」を参照してください。	123e4567-e89b-12d3-a456-42665544****
ScalingGroupId	string	必須	スケーリンググループの ID。	asg-bp18p2yfxow2dloq****
MinHealthyPercentage	integer	任意	インスタンスリフレッシュ中にスケーリンググループ内でサービス状態を維持する必要があるインスタンスの最小パーセント値。有効な値: 0～100。デフォルト値: 80。	80
MaxHealthyPercentage	integer	任意	インスタンスリフレッシュ中にスケーリンググループ内のインスタンス数がスケーリンググループの容量を超えることができる最大パーセント値。有効な値: 100～200。デフォルト値: 120。説明 MinHealthyPercentage と MaxHealthyPercentage の両方を 100 に設定した場合、一度に 1 つのインスタンスがリフレッシュされます。	100
DesiredConfiguration	object	任意	インスタンスリフレッシュの希望する構成。説明 ScalingConfigurationId、ImageId、LaunchTemplateId、および Containers を同時に指定することはできません。いずれか 1 つを指定する必要があります。リフレッシュタスクは、スケーリンググループ内で既に希望する構成と一致しているインスタンスをスキップします。
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	任意	起動テンプレートで指定されたインスタンスタイプをオーバーライドするインスタンスタイプ。	ecs.g7.2xlarge
Containers	array<object>	任意	インスタンスに含まれるコンテナのリスト。
	array<object>	任意	インスタンスに含まれるコンテナのリスト。
Name	string	任意	カスタムコンテナ名。	nginx
Image	string	任意	コンテナイメージ。	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
Commands	array	任意	コンテナの起動コマンド。最大 20 個のコマンドがサポートされています。各コマンドは最大 256 文字です。
	string	任意	コンテナの起動コマンド。コマンドは最大 256 文字です。	sleep
Args	array	任意	コンテナ起動コマンドの引数。最大 10 個の引数がサポートされています。
	string	任意	コンテナ起動コマンドの引数。	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: 希望する構成のイメージを指定して既存のインスタンスのシステムクラウドディスクを更新し、インスタンスのシステムクラウドディスクを置き換えます。デフォルト値: 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*****"
}

エラーコード

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

変更履歴

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