Configures auto-renewal for instances.
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 |
|---|---|---|---|---|
| ens:ModifyInstanceAutoRenewAttribute | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceIds | string | Yes | The IDs of the instances. Separate IDs with semicolons (;). | instance-test |
| AutoRenew | string | Yes | Specifies whether to enable the auto-renewal feature. Valid values: True and False. Default value: False. | false |
| Duration | string | No | The auto-renewal period of the instance. Unit: months. Valid values: 1 to 9 and 12. This parameter is required if the AutoRenew parameter is set to true. | 12 |
| RenewalStatus | string | No | Specifies whether to renew the instance. The RenewalStatus parameter has a higher priority than the AutoRenew parameter. If you do not specify RenewalStatus, the AutoRenew parameter is used by default.
The system no longer sends an expiration notification but sends only a renewal notification three days before the instance expires. To renew the instance, you can change the value of this parameter from NotRenewal to Normal and then manually renew the instance, or change the value of this parameter from NotRenewal to AutoRenewal. | Normal |
Response parameters
Examples
Sample success responses
JSONformat
{
"Code": 0,
"RequestId": "4DD66F05-3116-4BAA-B588-52EB2E7F431D"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | MissingParameter | The input parameters that is mandatory for processing this request is not supplied. | - |
| 400 | InstanceNotExists | The user have no instances. | - |
| 400 | CallInterface | Call Interface Happen Error. | An error occurred when you call the operation. |
| 400 | NoPermission | Permission denied. | - |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-03-12 | The Error code has changed | View Change Details |