tencent cloud



Last updated: 2023-12-04 16:31:56

    1. API Description

    Domain name for API request: lighthouse.tencentcloudapi.com.

    This API is used to renew one or more Lighthouse instances.

    • You can only perform this operation on instances whose status is RUNNING, STOPPED and SHUTDOWN.
    • Batch operations are supported. Up to 100 instances are supported in each request.
    • This API is async. After the request is sent successfully, a RequestId will be returned. At this time, the operation is not completed immediately. The result of the instance operation can be queried by calling the DescribeInstances API. If the latest operation status (LatestOperationState) of the instance is SUCCESS, the operation is successful.

    A maximum of 20 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: 2020-03-24.
    Region No String Common Params. This parameter is not required for this API.
    InstanceIds.N Yes Array of String IDs of one or more instances to be operated. The value can be obtained from the InstanceId parameter returned by the DescribeInstances API. Up to 100 instances can be requested at a time.
    InstanceChargePrepaid Yes InstanceChargePrepaid Prepaid mode, i.e., monthly subscription. This parameter can specify the purchase period and other attributes such as auto-renewal. It is required for prepaid instances.
    RenewDataDisk No Boolean Whether to renew elastic data disks. Values:
    TRUE: Renew the elastic data disks attached to the instance as well when the related instance is renewed.
    FALSE: Do not renew the elastic data disks attached to the instance as well when the related instance is renewed.
    Default: TRUE
    AutoVoucher No Boolean Whether to automatically use vouchers. Values:
    TRUE: Use vouchers for payment automatically.
    FALSE: Do not use vouchers for payment automatically.
    Default: FALSE.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Renewing specific instances

    Input Example

    POST / HTTP/1.1
    Host: lighthouse.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: RenewInstances
    <Common request parameters>
        "InstanceIds": [
        "InstanceChargePrepaid": {
            "Period": 1
        "AutoVoucher": true,
        "RenewDataDisk": true

    Output Example

        "Response": {
            "RequestId": "c139e106-cdb2-4923-8f1e-ea1dc4fe3a47"

    5. Developer Resources


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

    Command Line Interface

    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
    AuthFailure Error with CAM signature/authentication.
    FailedOperation Operation failed.
    FailedOperation.RenewResourcesFailed Unable to renew the resource
    InvalidParameter.InvalidFilter Invalid parameter: the Filter parameter is invalid.
    InvalidParameter.InvalidFilterInvalidKey Invalid parameter: the value of Name in the Filter parameter is invalid.
    InvalidParameter.InvalidFilterInvalidNameNotStr Invalid parameter: the value of Name in the Filter parameter is not a string.
    InvalidParameter.InvalidFilterInvalidValuesNotList Invalid parameter: the Values in the Filter parameter is not a list.
    InvalidParameter.InvalidFilterNotDict Invalid parameter: the Filter parameter is not a dictionary.
    InvalidParameter.InvalidFilterNotSupportedName Invalid parameter: there are unsupported Name values in the Filter parameter.
    InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
    InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
    InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
    OperationDenied.DiskOperationInProgress The disk is being manipulated. Try again later.
    OperationDenied.InstanceCreating It is not allowed to manipulate this instance, as it is being created.
    OperationDenied.InstanceOperationInProgress It is not allowed to manipulate this instance, as the last operation is still in progress.
    ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    UnsupportedOperation.DiskLatestOperationUnfinished Unsupported operation: the last operation of the disk has not been completed.
    UnsupportedOperation.InvalidDiskState The disk's status does not support this operation.
    UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support