DescribeInstanceRefreshes

如果您需要檢視實例重新整理任務的基本資訊、實例重新整理任務的進度等資訊，您可以呼叫DescribeInstanceRefreshes查詢該伸縮組的實例重新整理任務。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ess:DescribeInstanceRefreshes

get

*ScalingGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	伸縮組所屬的地域 ID。	cn-hangzhou
NextToken	string	否	查詢憑證（Token）。取值為上一次呼叫該介面返回的 NextToken 參數值，初次呼叫介面時無需設定該參數。	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	否	分頁查詢時每頁的最大條目數，取值範圍：1~50。預設值：10。	10
ScalingGroupId	string	否	伸縮組的 ID。說明呼叫該 API 時，ScalingGroupId 和 InstanceRefreshTaskIds 參數必須二選一進行配置，如果兩個參數同時都不配置，則會報錯。	asg-bp1ffogfdauy0jw0****
InstanceRefreshTaskIds	array	否	待查詢實例重新整理任務的 ID。
	string	否	待查詢實例重新整理任務的 ID。	ir-adfa12312*****

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
NextToken	string	下一個查詢開始的 Token，NextToken 為空表示沒有下一個。	caeba0bbb2be03f84eb48b699f****
MaxResults	integer	單頁查詢的最大條目數。	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	實例重新整理任務當前的狀態，可能值： Pending：實例重新整理任務建立成功，等待排程； InProgress：實例重新整理任務正在處理中； Paused: 實例重新整理任務處於暫停中； CheckpointPause：因任務進度到達重新整理任務檢查點（`Checkpoint.Percentage`）而處於暫停狀態； Failed：實例重新整理任務執行失敗； Successful：實例重新整理任務執行成功； Cancelling：實例重新整理任務取消中； Cancelled: 實例重新整理任務取消完成； RollbackInProgress：實例重新整理任務回滾中； RollbackSuccessful：實例重新整理任務回滾成功； RollbackFailed: 實例重新整理任務回滾失敗；	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	執行個體啟動模板的版本。可能值：固定的模板版本號碼。 Default：始終使用模板預設版本。 Latest：始終使用模板最新版本。	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：跳過。當啟動實例重新整理任務時，系統會檢查每個實例的配置。對於已經使用期望配置建立的實例，不執行重新整理操作。 false：不跳過。在啟動實例重新整理任務後，重新整理任務啟動時所有伸縮組中的實例。	true
CheckpointPauseTime	integer	當進入重新整理任務檢查點時，暫停的時長。單位：分鐘。	30
Checkpoints	array<object>	重新整理任務檢查點：指定在實例重新整理過程中，當新實例佔比達到設定值時自動暫停任務 CheckpointPauseTime 分鐘。
	object	重新整理任務檢查點：指定在實例重新整理過程中，當新實例佔比達到設定值時自動暫停任務 CheckpointPauseTime 分鐘。
Percentage	integer	伸縮組中新執行個體佔總執行個體的佔比，到達該佔比時任務自動暫停。	60
Strategy	string

樣本

正常返回樣本

JSON格式

{
  "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
        }
      ]
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。