Queries instance refresh tasks. If you want to view the basic information and execution progress of an instance refresh task, you can call the DescribeInstanceRefreshes operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ess:DescribeInstanceRefreshes | get | *ScalingGroup acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the scaling group to which the instance refresh task belongs. | cn-hangzhou |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. | caeba0bbb2be03f84eb48b699f0a**** |
| MaxResults | integer | No | The maximum number of entries per page. Valid values: 1 to 50. Default value: 10. | 10 |
| ScalingGroupId | string | No | The ID of the scaling group. Note
When you call this operation, you must specify one of the following parameters: ScalingGroupId and InstanceRefreshTaskIds. You cannot specify both of them. If you specify neither of them, an error is reported.
| asg-bp1ffogfdauy0jw0**** |
| InstanceRefreshTaskIds | array | No | The IDs of the instance refresh tasks that you want to query. | |
| string | No | The ID of the instance refresh task that you want to query. | ir-adfa12312***** |
Response parameters
Examples
Sample success responses
JSONformat
{
"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****"
},
"FinishedUpdateCapacity": 10,
"TotalNeedUpdateCapacity": 20,
"SkipMatching": true
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-12-10 | The response structure of the API has changed | View Change Details |