RenewInstances

Download PDF

Last updated:2026-01-13 21:47:06

RenewInstances

Last updated: 2026-01-13 21:47:06

Download PDF

1. API Description

Domain name for API request: cvm.intl.tencentcloudapi.com.

This API is used to renew annual and monthly subscription instances.

This API is used to operate on monthly subscription instances only.
This API is used to ensure your account balance is sufficient for renewal. You can check the balance via the DescribeAccountBalance API (https://www.tencentcloud.com/document/product/555/20253?from_cn_redirect=1).

You can query the result of the instance operation by calling the API DescribeInstances. If the latest operation status (LatestOperationState) of the instance is SUCCESS, the operation is successful.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: RenewInstances.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceIds.N	Yes	Array of String	One or more instance IDs to be operated. You can obtain the instance ID through the `InstanceId` in the return value from the API DescribeInstances. The maximum number of instances per request is 100.
InstanceChargePrepaid	No	InstanceChargePrepaid	Prepaid mode, that is, parameter settings related to monthly/annual subscription. specifies attributes of a monthly subscription instance, such as renewal duration and whether to enable auto-renewal, by specifying this parameter. . Annual and monthly subscription instances. this parameter is a required parameter..
RenewPortableDataDisk	No	Boolean	Whether to renew the elastic data disk. valid values: true: indicates renewing the annual and monthly subscription instance and its mounted elastic data disk simultaneously false: indicates renewing the annual and monthly subscription instance while no longer renewing its mounted elastic data disk default value: true.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Renewing an Instance

This example shows you how to renew an instance, specify the instance Id as ins-r8hr2upy, renew for one month, notify that the account is about to expire upon expiration but auto-renewal is not performed.

Input Example

POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewInstances
<Common request parameters>

{
    "InstanceChargePrepaid": {
        "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
        "Period": 1
    },
    "InstanceIds": [
        "ins-r8hr2upy"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.InvalidInstanceApplicationRole	The applicationRole instance does not support the operation.
FailedOperation.InvalidInstanceApplicationRoleEmr	The EMR instance `ins-xxxxxxxx` does not support this operation.
InternalError.TradeUnknownError	Internal error.
InternalServerError	Internal error.
InvalidAccount.InsufficientBalance	Insufficient account balance.
InvalidAccount.UnpaidOrder	The account has unpaid orders.
InvalidInstance.NotSupported	This instance is not supported.
InvalidInstanceId.Malformed	Invalid instance `ID`. The specified instance `ID` has an invalid format. For example, `ins-1122` has an invalid `ID` length.
InvalidInstanceId.NotFound	No instance found.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.InstanceIdMalformed	Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
InvalidParameterValue.InstanceNotSupportedMixPricingModel	Operation not supported for instances with different billing modes.
InvalidParameterValue.LimitExceeded	The number of parameter values exceeds the limit.
InvalidPeriod	Invalid period. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]; unit: month.
MissingParameter	Missing parameter.
OperationDenied.InstanceOperationInProgress	The instance has an operation in progress. Please try again later.
UnsupportedOperation.InstanceChargeType	This instance billing mode does not support the operation.
UnsupportedOperation.InstanceMixedZoneType	Central AZ and edge zone instances cannot be mixed in batch operation.
UnsupportedOperation.InstanceStateBanning	This CVM is blocked. Please submit a ticket.
UnsupportedOperation.InstanceStateFreezing	The operation is not supported for the frozen instances.
UnsupportedOperation.InstanceStatePending	The instances are being created, and this operation is not supported.
UnsupportedOperation.InstanceStateRebooting	The instances are being restarted, and this operation is not supported.
UnsupportedOperation.InstanceStateStarting	The instance is starting up, and this operation is not supported.
UnsupportedOperation.InstanceStateStopping	The instance is being shut down, and this operation is not supported.
UnsupportedOperation.InstanceStateTerminating	The instance is being terminated, and the operation is not supported.
UnsupportedOperation.InvalidDiskBackupQuota	Cloud block storage does not support backup points.
UnsupportedOperation.PeriodicContractNotSupportManualRenew
UnsupportedOperation.SpecialInstanceType	This special instance type does not support the operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud