All Products
Search
Document Center

RenewInstance

Last Updated: Aug 27, 2019

API Name

RenewInstance

Overview

You can call this operation to renew a specified instance. When you make the API request, the system generates a corresponding order and pays for this order automatically. If the payment is failed, the order is cancelled.This API does not support ECS & RDS instance.

Request parameters

Name Type Required Description
OwnerId Long No The ID of the owner, which is a 16-digit number. The parameter is required if the owner is a reseller or a distributer.
ProductCode String Yes The code of the specified product.
ProductType String No The type of the specified product.
InstanceId String Yes The ID of the specified instance that you want to renew.
RenewPeriod String Yes The renewal period of the subscription instance. Unit: months. Valid values: 1–9, 12, 24, and 36.
ClientToken String Yes Used to ensure the idempotence of the request. The client generates the token to make a unique request. The token contains a maximum of 64 ASCII characters and cannot contain any non-ASCII characters.

Response parameters

Name Type Required
Success Boolean Indicates whether the call is successful.
Code String The error code of a failed call.
Message String The details of the response.
RequestId String The GUID generated by Alibaba Cloud for the request.
Data RenewInstanceResponse For more information, see the RenewInstanceResponse data dictionary.

Error codes

Error code Description HTTP status code Description
NotApplicable This API is not applicable for caller. 400 The error message returned when you are not authorized to use the API.
MissingParameter The specified parameter xx is mandatory for this request. 400 The error message returned when the xx parameter is not specified.
InvalidParameter The specified parameter xx is not valid. 400 The error message returned when the xx parameter is invalid.
InvalidModuleCode The specified moduleCode is not valid. 400 The error message returned when the specified moduleCode parameter is invalid.
InvalidConfigCode The specified configCode is not valid. 400 The error message returned when the specified configCode parameter is invalid.
InvalidOwner The specified owner doesn’t belong to caller. 400 The error message returned when the specified owner does not belong to the caller.
InvalidCaller The specified caller doesn’t exists. 400 The error message returned when the caller is invalid.
InternalError The request processing has failed due to some unknown error, exception or failure. 400 The error message returned when an unknown internal error occurs.
ProductNotFind Can not find inquired product, it may not exist. 400 The error message returned when the specified product is invalid.

Sample requests

Sample responses

Data dictionary

RenewInstanceResponse

Name Type Description
OrderId Long The ID of the order that you created.