Modifies information about an elasticity assurance, including the name, description, and capacity. Only capacity scale-in is supported .
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:
- For mandatory resource types, indicate with a prefix of * .
- 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 |
|---|---|---|---|---|
| ecs:ModifyElasticityAssurance | update | *ElasticityAssurance acs:ecs:{#regionId}:{#accountId}:elasticityassurance/{#ElasticityAssuranceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the elasticity assurance. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| PrivatePoolOptions.Id | string | Yes | The ID of the elasticity assurance. | eap-bp67acfmxazb4**** |
| PrivatePoolOptions.Name | string | No | The name of the elasticity assurance. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. The name can contain digits, colons (:), underscores (_), and hyphens (-). | eapTestName |
| Description | string | No | The description of the elasticity assurance. The description must be 2 to 256 characters in length and cannot start with | This is description. |
| InstanceAmount | integer | No | The total number of instances for which you want to reserve capacity. Valid values: the number of created instances to 1000. This parameter is mutually exclusive with other parameters in the same request. | 10 |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence. | 123e4567-e89b-12d3-a456-426655440000 |
| RecurrenceRules | array<object> | No | The assurance schedules based on which the capacity reservation takes effect. Note
Time-segmented elasticity assurances are available only in specific regions and to specific users. To use time-segmented elasticity assurances, submit a ticket.
| |
| object | No | The assurance schedule based on which the capacity reservation takes effect. Note
| ||
| RecurrenceType | string | No | The type of the assurance schedule. Valid values:
Note
You must specify both RecurrenceType and RecurrenceValue.
| Daily |
| RecurrenceValue | string | No | The days of the week or month on which the capacity reservation takes effect or the interval, in number of days, at which the capacity reservation takes effect.
Note
You must specify both RecurrenceType and RecurrenceValue.
| 5 |
| StartHour | integer | No | The start time of the assurance period for the capacity reservation. Specify an on-the-hour point in time. Note
You must specify both StartHour and EndHour. EndHour must be at least four hours later than StartHour.
| 4 |
| EndHour | integer | No | The end time of the assurance period for the capacity reservation. Specify an on-the-hour point in time. | 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "8455DD10-84F8-43C9-8365-5F448EB169B6"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidRecurrenceRules.CountLimitExceeded | The count of RecurrenceRules exceeds the limit. | The number of parameter RecurrenceRules exceeds the limit value. |
| 400 | InvalidRecurrenceRules.Unsupported | The specified parameter RecurrenceRules does not support for this resource package. | The resource bundle does not support the specified parameter RecurrenceRules. |
| 400 | InvalidRecurrenceRulesStartHourEndHour.TooShort | The recurrence hour between RecurrenceRules.StartHour and RecurrenceRules.EndHour is too short. | The effective time between parameter RecurrenceRules.StartHour and RecurrenceRules.EndHour is less than the minimum requirement. |
| 400 | InvalidParameter.RecurrenceRulesStartHourEndHour | The specified parameter RecurrenceRules.StartHour or RecurrenceRules.EndHour is invalid. | The parameter RecurrenceRules.StartHour or RecurrenceRules.EndHour specified for the RecurrenceRules does not conform to the specification. |
| 400 | InvalidParameter.RecurrenceRulesRecurrenceValueMonthly | The specified parameter RecurrenceRules.RecurrenceValue for Monthly is invalid. | The parameter RecurrenceRules.RecurrenceValue specified for the RecurrenceRules.RecurrenceType = Monthly does not conform to the specification. |
| 400 | InvalidParameter.RecurrenceRulesRecurrenceValueWeekly | The specified parameter RecurrenceRules.RecurrenceValue for Weekly is invalid. | The parameter RecurrenceRules.RecurrenceType specified for RecurrenceRules.RecurrenceValue = Weekly is out of specification. |
| 400 | InvalidParameter.RecurrenceRulesRecurrenceValueDaily | The specified parameter RecurrenceRules.RecurrenceValue for Daily is invalid. | The parameter RecurrenceRules.RecurrenceType specified for RecurrenceRules.RecurrenceValue = Daily does not conform to the specification. |
| 400 | InvalidParameter.RecurrenceRulesRecurrenceType | The specified parameter RecurrenceRules.RecurrenceType is invalid. | The specified parameter RecurrenceRules.RecurrenceType does not conform to specification. |
| 400 | InvalidInstanceAmount.ValueNotSupported | The specified parameter InstanceAmount is not valid. | The specified parameter InstanceAmount is invalid. |
| 400 | InvalidDescription.ValueNotSupported | The specified Description is invalid. | - |
| 400 | InvalidEndTime.ValueNotSupported | The specified EndTime is invalid. | - |
| 400 | InvalidStartTime.ValueNotSupported | The specified StartTime is invalid. | - |
| 400 | InvalidParameter.PrivatePoolOptions.Name | The parameter PrivatePoolOptions.Name is invalid. | The specified parameter PrivatePoolOptions.Name is invalid. |
| 400 | InvalidParameter.ClientToken | The parameter ClientToken is invalid. | The specified parameter ClientToken is invalid. |
| 400 | InvalidParameter.Description | The parameter Description is invalid. | The specified parameter Description is invalid. |
| 401 | InvalidUser.Unauthorized | The user is not authorized. | The account you are currently using does not have permission. |
| 403 | InvalidOperation.ModifyTotalActiveTimeUnsupported | Not support to modify the total active time of resource package. | Not support to modify the total active time of resource package. |
| 403 | IncorrectPrivatePoolStatus | The current status of the private pool does not support this operation. | The specified private pool state does not support the operation. |
| 403 | OperationDenied.NoStock | The requested resource is sold out in the specified zone; try other types of resources or other regions and zones. | The requested resources are insufficient. |
| 403 | InvalidPrivatePoolOptionsName.ValueNotSupported | The specified PrivatePoolOptions.Name is invalid. | - |
| 403 | InvalidPlatform.ValueNotSupported | The specified Platform is invalid. | - |
| 403 | OperationDenied.PlatformNotSupported | The specified private pool does not support this operation. | - |
| 403 | OperationDenied.EndTimeTypeNotSupported | The specified private pool does not support this operation. | - |
| 403 | OperationDenied.StartTimeNotSupported | The specified private pool does not support this operation. | - |
| 403 | OperationDenied.InstanceAmountNotSupported | The specified private pool does not support this operation. | - |
| 403 | InvalidInstanceAmount.ValueNotSupported | The specified InstanceAmount is invalid. | - |
| 403 | InvalidPrivatePoolOptions.Id | The specified private pool does not support this operation. | - |
| 403 | InvalidPrivatePoolOptions.Id | The specified PrivatePoolOptions.Id is invalid. | The specified private pool is invalid |
| 403 | InvalidInstanceAmount.LessThanUsedAmount | The specified parameter InstanceAmount is less than UsedAmount. | The specified parameter InstanceAmount is less than the used capacity. |
| 403 | InvalidOperation.InstanceAmountAndOtherAttributesUnsupported | Modify InstanceAmount and other attributes simultaneously is not supported. | Cannot modify InstanceAmount and other properties simultaneously. |
| 404 | InvalidPrivatePoolId.NotFound | The specified private pool does not exist. | The specified private pool does not exist |
| 500 | InternalError | The request processing has failed due to some unknown error. | An internal error has occurred. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-02-19 | API Description Update. The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2024-09-27 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-12-06 | The Error code has changed | View Change Details |