Domain name for API request: as.tencentcloudapi.com.
This API is used to generate a new instance refresh activity, which also supports batched refreshing and operations such as pausing, resuming, and canceling. The interface returns the RefreshActivityId for the rollback activity.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: RollbackInstanceRefresh. |
Version | Yes | String | Common Params. The value used for this API: 2018-04-19. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
AutoScalingGroupId | Yes | String | Scaling group ID. |
RefreshSettings | Yes | RefreshSettings | Refresh settings. |
OriginRefreshActivityId | Yes | String | Original refresh activity ID. |
RefreshMode | No | String | Refresh mode, currently, only rolling updates are supported, with the default value being ROLLING_UPDATE_RESET. |
Parameter Name | Type | Description |
---|---|---|
RefreshActivityId | String | Refresh activity ID. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to roll back the instance refresh activity asr-i8u7tytd for the scaling group asg-9dn1a5y6.
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartInstanceRefresh
<Common request parameters>
{
"AutoScalingGroupId": "asg-9dn1a5y6",
"RefreshMode": "ROLLING_UPDATE",
"OriginRefreshActivityId": "asr-i8u7tytd",
"RefreshSettings": {
"RollingUpdateSettings": {
"BatchNumber": 3,
"BatchPause": "BATCH_INTERVAL_PAUSE"
}
}
}
{
"Response": {
"RefreshActivityId": "asr-y67t5r4e",
"RequestId": "c4190090-bc60-4f48-b9d4-48095b9596db"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InvalidParameterValue.BatchNumberTooLarge | The batch count cannot exceed the total number of instances pending refresh. |
ResourceNotFound.AutoScalingGroupIdNotFound | The scaling group does not exist. |
ResourceUnavailable.AutoScalingGroupAbnormalStatus | The auto scaling group is exceptional. |
ResourceUnavailable.AutoScalingGroupInActivity | The auto scaling group is active. |
ResourceUnavailable.AutoScalingGroupInRefreshActivity | The scaling group is already involved in another instance refresh activity. |
ResourceUnavailable.InquiryPriceResetInstanceFailed | The instance reinstallation quotation failed, because the new image conflicts with other parameters of the instance or the new image does not exist. |
ResourceUnavailable.NoInstanceCanRefresh | There are no instances in running status within the scaling group, making it impossible to perform an instance refresh. |
ResourceUnavailable.NoInstanceCanRollback | There are no instances eligible for rollback in the scaling group. |
ResourceUnavailable.RefreshActivityCanNotRollback | The current refresh activity is in a successful status and not the most recent execution, so it cannot be rolled back. |
ResourceUnavailable.RefreshActivityStatusConflictWithOperation | The instance refresh activity status conflicts with the current operation. |
ResourceUnavailable.RollbackTypeActivityCanNotRollbackAgain | Rollback type instance refresh activity cannot be rolled back again. |
UnauthorizedOperation.AutoScalingRoleUnauthorized | You have not assigned the CAM role AS-QCSRole to Auto Scaling. Please go to the AS console to complete authorization first. |
Was this page helpful?