スケーリンググループ内のインスタンスリフレッシュタスクの基本情報および進捗状況を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ess:DescribeInstanceRefreshes |
get |
*ScalingGroup
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
スケーリンググループのリージョン ID。 |
cn-hangzhou |
| NextToken |
string |
任意 |
ページネーショントークン。このパラメーターには、前回の呼び出しで返された NextToken の値を設定します。最初のリクエストでは設定不要です。 |
caeba0bbb2be03f84eb48b699f0a**** |
| MaxResults |
integer |
任意 |
ページングクエリにおける 1 ページあたりの最大値。有効な値: 1～50。 デフォルト値: 10。 |
10 |
| ScalingGroupId |
string |
任意 |
スケーリンググループの ID。 説明
ScalingGroupId または InstanceRefreshTaskIds のいずれかを指定する必要があります。どちらのパラメーターも指定しない場合、エラーが返されます。 |
asg-bp1ffogfdauy0jw0**** |
| InstanceRefreshTaskIds |
array |
任意 |
クエリするインスタンスリフレッシュタスクの ID。 |
|
|
string |
任意 |
クエリするインスタンスリフレッシュタスクの ID。 |
ir-adfa12312***** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| NextToken |
string |
次のクエリのページネーショントークン。NextToken が空の場合、これ以上結果はありません。 |
caeba0bbb2be03f84eb48b699f**** |
| MaxResults |
integer |
1 ページあたりの最大値。 |
50 |
| TotalCount |
integer |
インスタンスリフレッシュタスクの総数。 |
100 |
| InstanceRefreshTasks |
array<object> |
インスタンスリフレッシュタスクのリスト。 |
|
|
array<object> |
インスタンスリフレッシュタスク。 |
||
| ScalingGroupId |
string |
スケーリンググループの ID。 |
asg-bp16pbfcr8j9***** |
| InstanceRefreshTaskId |
string |
インスタンスリフレッシュタスクの ID。 |
ir-1adfa123**** |
| RegionId |
string |
スケーリンググループのリージョン ID。 |
cn-hangzhou |
| EndTime |
string |
インスタンスリフレッシュタスクの終了時刻。 |
2024-08-22T02:09:00Z |
| StartTime |
string |
インスタンスリフレッシュタスクの開始時刻。 |
2024-08-22T01:09:00Z |
| Status |
string |
インスタンスリフレッシュタスクの現在のステータス。有効な値:
|
InProgress |
| Detail |
string |
インスタンスリフレッシュタスクが失敗した場合の失敗理由。 |
The task exceeded its maximum run time of one week. So the task failed. |
| 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 |
起動テンプレートのバージョン。有効な値:
|
Latest |
| LaunchTemplateOverrides |
array<object> |
起動テンプレートを上書きするインスタンスタイプ情報。 |
|
|
object |
起動テンプレートを上書きするインスタンスタイプ情報。 |
||
| InstanceType |
string |
起動テンプレートで指定されたインスタンスタイプを上書きするインスタンスタイプ。 |
ecs.sn1ne.large |
| Containers |
array<object> |
インスタンスに含まれるコンテナのリスト。 |
|
|
array<object> |
インスタンスに含まれるコンテナのリスト。 |
||
| Name |
string |
カスタムコンテナ名。 |
name |
| Image |
string |
コンテナイメージ。 |
registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest |
| Commands |
array |
コンテナの起動コマンド。 |
|
|
string |
コンテナの起動コマンド。 |
sleep |
|
| Args |
array |
コンテナの起動コマンドの引数。 |
|
|
string |
コンテナの起動コマンドの引数。 |
100 |
|
| EnvironmentVars |
array<object> |
環境変数情報。 |
|
|
object |
環境変数情報。 |
||
| Key |
string |
環境変数の名前。 |
PATH |
| Value |
string |
環境変数の値。 |
/usr/local/bin |
| FieldRefFieldPath |
string |
説明
このパラメーターは使用できません。 |
fieldPath |
| FinishedUpdateCapacity |
integer |
リフレッシュ済みのキャパシティ。 |
10 |
| TotalNeedUpdateCapacity |
integer |
リフレッシュが必要なキャパシティの合計。 |
20 |
| SkipMatching |
boolean |
すでに希望構成と一致しているインスタンスをスキップするかどうかを示します。 説明
システムは、個々の構成項目を比較するのではなく、希望するスケーリング設定の ID に基づいてインスタンスが一致するかどうかを判断します。 有効な値:
|
true |
| CheckpointPauseTime |
integer |
タスクがチェックポイントに達したときの一時停止持続時間。単位: 分。 |
30 |
| Checkpoints |
array<object> |
リフレッシュタスクのチェックポイント。チェックポイントは、インスタンスリフレッシュ中に新しいインスタンスの割合が指定された値に達したときに、タスクが自動的に CheckpointPauseTime 分間一時停止することを指定する呼び出しです。 |
|
|
object |
リフレッシュタスクのチェックポイント。チェックポイントは、インスタンスリフレッシュ中に新しいインスタンスの割合が指定された値に達したときに、タスクが自動的に CheckpointPauseTime 分間一時停止することを指定する呼び出しです。 |
||
| Percentage |
integer |
スケーリンググループ内の合計インスタンスに対する新しいインスタンスの割合。この割合に達するとタスクが自動的に一時停止します。 |
60 |
| Strategy |
string |
インスタンスリフレッシュタスクの実行戦略。有効な値:
|
Rolling |
例
成功レスポンス
JSONJSON
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"NextToken": "caeba0bbb2be03f84eb48b699f****",
"MaxResults": 50,
"TotalCount": 100,
"InstanceRefreshTasks": [
{
"ScalingGroupId": "asg-bp16pbfcr8j9*****",
"InstanceRefreshTaskId": "ir-1adfa123****",
"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": [
{
"InstanceType": "ecs.sn1ne.large"
}
],
"Containers": [
{
"Name": "name",
"Image": "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest",
"Commands": [
"sleep"
],
"Args": [
"100"
],
"EnvironmentVars": [
{
"Key": "PATH",
"Value": "/usr/local/bin",
"FieldRefFieldPath": "fieldPath"
}
]
}
]
},
"FinishedUpdateCapacity": 10,
"TotalNeedUpdateCapacity": 20,
"SkipMatching": true,
"CheckpointPauseTime": 30,
"Checkpoints": [
{
"Percentage": 60
}
],
"Strategy": "Rolling"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。