Use TransformToPrePaid to change a pay-as-you-go instance to subscription - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

To perform the equivalent operation in the console, see Change the billing method to subscription.

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:TransformToPrePaid

update

*DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. You can call the DescribeInstances operation to obtain the instance ID.	r-bp1zxszhcgatnx****
Period	integer	Yes	The subscription duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.	12
AutoPay	boolean	No	Specifies whether to enable auto-payment. Valid values: true: Automatically completes the payment. false (default): An order is generated, but is not automatically paid. You must then log on to the console to pay for the order. For more information, see Manually renew an instance.	true
AutoRenew	string	No	Specifies whether to enable auto-renewal for the instance. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled.	false
AutoRenewPeriod	integer	No	The auto-renewal period. Unit: months. Valid values: 1, 2, 3, 6, and 12. Note This parameter is required if AutoRenew is set to true.	3
CouponNo	string	No	The coupon code.

Response elements

Element	Type	Description	Example
	object	The response object.
EndTime	string	The expiration time of the instance's new subscription.	2019-01-18T16:00:00Z
RequestId	string	The request ID.	426F1356-B6EF-4DAD-A1C3-DE53B9DAF586
OrderId	string	The order ID.	111111111111111

Examples

Success response

JSON format

{
  "EndTime": "2019-01-18T16:00:00Z",
  "RequestId": "426F1356-B6EF-4DAD-A1C3-DE53B9DAF586",
  "OrderId": "111111111111111"
}

Error response

JSON format

{
 "OrderId":"202636204910941",
 "RequestId":"426F1356-B6EF-4DAD-A1C3-DE53B9DAF586",
 "EndTime":"2019-01-18T16:00:00Z"
}

Error codes

HTTP status code	Error code	Error message
400	MissingParameter	Period is mandatory for this action.
400	InvalidParam	Period is invalid
400	ResourceNotAvailable	Resource you requested is not available for finance user.
400	InsufficientBalance	Your account does not have enough balance.
400	Order.LatestOrderIsHanding	Latest order is handing, please retry later.
403	AlreadyPrePaid	This instance is already prepaid
403	RealNameAuthenticationError	Your account has not passed the real-name authentication yet.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.