Call the RenewInstance operation to renew a subscription instance, prioritizing coupon deduction for renewal. The subscription volumes and images are synchronously renewed.

Usage notes

You can only call this operation to renew a subscription instance.

Before calling this operation, you can learn about the billing method and pricing of ECS instances. Learn more.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.

Action string required Sample value: RenewInstance

The operation that you want to perform. Valid value: RenewInstance.

Version string required Sample value: 2020-04-01

The API version. Valid value: 2020-04-01.

ClientToken string Optional Sample value: 23fa21A8823nfasd7f****

The ClientToken is used to ensure the request idempotency. You can use the client to automatically generate a token, but you must make sure that the token is unique among different requests. This prevents repeated actions due to multiple client retries when the call of the API operation times out or an internal server error occurs.

Value: Only ASCII characters are supported. The length is no more than 64 ASCII characters.

InstanceId string required Sample value: i-3thhlu8byl4bwbha****

The instance ID.

Period integer required Sample value: 1

The number of months for renewal. Valid values:

1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36

PeriodUnit string required Sample value: Month

The time unit of the renewal duration, that is, the unit of the Period parameter. Value:

Month (default)

Week (not supported)

Response parameters

Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.

OrderId string Sample value: Order7007335217124******

The order ID.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	The idempotent parameters are inconsistent.
400	Insufficient.Balance	The request is denied due to the lack of balance.	The account balance is insufficient.
400	InvalidArgument	The specified argument is invalid.	The specified parameter is invalid.
400	InvalidChargeType	The specified ChargeType is not valid, is unsupported, or cannot be used.	The specified instance billing method is invalid.
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	The specified ClientToken is invalid.
400	InvalidPeriod	The specified period is not valid.	The specified number of billing cycles is invalid.
400	InvalidPeriodUnit	The specified PeriodUnit is not valid, is unsupported, or cannot be used.	The specified billing cycle is invalid.
400	MissingParameter.InstanceId	The required parameter InstanceId is not supplied.	The parameter InstanceId cannot be left empty.
403	InvalidInstance.RequestForbidden	Request is forbidden by the server.	The specified resource can no longer be used because your account has violated relevant rules. To restore service availability, submit a ticket to our service team for assistance.
404	InvalidInstance.NotFound	The specified instance does not exist.	The specified instance does not exist.
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	The previous idempotent request is still in process. Please try again later.
412	OperationDenied.AffinityGroupInstance	The specified operation is denied as your instance is an affinity group instance, and all instanceIds the affinity group must be specified.	The specified operation is rejected because the instance is an affinity group instance, and you must specify the IDs of all instances in the affinity group.
412	OperationDenied.ResourceLocked	The specified operation is denied as your resource is locked for another operation.	The specified operation is rejected because your resource has been locked by another operation.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service