スケーリンググループのインスタンスリフレッシュタスクを照会し、基本情報とタスクの進捗状況を表示します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ess:DescribeInstanceRefreshes |
get |
*スケーリンググループ。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| 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 |
インスタンスリフレッシュタスクの終了時刻。時間は協定世界時 (UTC) で表示され、ISO 8601 標準の YYYY-MM-DDTHH:mm:ssZ フォーマットに従います。 |
2024-08-22T02:09:00Z |
| StartTime |
string |
インスタンスリフレッシュタスクの開始時刻。時間は協定世界時 (UTC) で表示され、ISO 8601 標準の YYYY-MM-DDTHH:mm:ssZ フォーマットに従います。 |
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"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。