RenewInstance - Renew a Tair Redis subscription instance - Tair (Redis® OSS-Compatible)

Renews a Tair (Redis OSS-compatible) subscription instance.

Operation description

This operation applies only to subscription instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:RenewInstance

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

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. You can specify this parameter to change the instance specifications during renewal. Note To change specifications during renewal, specify at least one of `Capacity` and `InstanceClass`.	-
InstanceClass	string	No	The instance type code. Available codes are listed in Instance specifications overview. You can specify this parameter to change the instance specifications during renewal. Note To change specifications during renewal, specify at least one of `Capacity` and `InstanceClass`.	-
Period	integer	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	Whether to automatically pay for the order. Default value: true. Valid values: true: enables automatic payment. false: disables automatic payment. If you set this parameter to false, go to Expenses > Renewal Management > Orders to complete the payment.	true
FromApp	string	No	The request source. Default value: OpenAPI. This value 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`.	youhuiquan_promotion_option_id_for_blank
ClientToken	string	No	The client token used to ensure idempotency. The token must be unique across requests, is case-sensitive, and can contain only ASCII characters with a maximum length of 64 characters.	0.6823317918435086
AutoRenew	boolean	No	Whether to enable auto-renewal. Valid values: true: enables auto-renewal based on the specified renewal period. false (default): disables auto-renewal.	false

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time of the order.	2019-02-19T00:00:00Z
RequestId	string	The ID of the request.	2222245-222A-4155-9349-E22222****
OrderId	string	The ID of the order.	111111111111111

Examples

Success response

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.