Renews an ApsaraDB for Redis instance.
Operation description
This operation is applicable only to subscription 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 Resources
is 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 |
---|---|---|---|---|
kvstore:RenewInstance | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The ID of the instance. | r-bp1zxszhcgatnx**** |
Capacity | string | No | The storage capacity of the instance. Unit: MB. When you renew the instance, you can specify this parameter to change specifications of the instance. Note
To change the specifications when you renew the instance, you must specify at least one of the Capacity and InstanceClass parameters.
| 1024 |
InstanceClass | string | No | The instance type code. For more information, see Instance specifications overview. When you renew the instance, you can specify this parameter to change specifications of the instance. Note
To change the specifications when you renew the instance, you must specify at least one of the Capacity and InstanceClass parameters.
| redis.master.small.default |
Period | long | Yes | The renewal period. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36. Unit: months. | 6 |
AutoPay | boolean | No | Specifies whether to enable automatic payment. Default value: true. Valid values:
If you select false, you must choose Expenses > Renewal Management in the top navigation bar. In the left-side navigation pane, click Orders. Find the specified order and pay for it. | true |
FromApp | string | No | The source of the request. The default value is OpenAPI and cannot be changed. | OpenAPI |
BusinessInfo | string | No | The ID of the promotional event or business information. | 000000000 |
CouponNo | string | No | The coupon code. Default value: | youhuiquan_promotion_option_id_for_blank |
ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token is case-sensitive. The token can contain only ASCII characters and cannot exceed 64 characters in length. | TF-ModifyInstanceSpec-1686645570-7dac7257-4a14-4811-939c-51a282f |
AutoRenew | boolean | No | Specifies whether to enable auto-renewal for the instance. Valid values:
| false |
Response parameters
Examples
Sample success responses
JSON
format
{
"EndTime": "2019-02-19T00:00:00Z",
"RequestId": "2222245-222A-4155-9349-E22222****",
"OrderId": "111111111111111"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | HasRenewChangeOrder | This instance has a renewChange order. | An order for renewal and configuration change already exists. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-01-30 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
| ||||||||||
2023-07-20 | API Description Update. The Error code has changed | see changesets | ||||||||
|