tencent cloud



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

    1. API Description

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

    This API is used change one or more Lighthouse instance bundles.

    • Only RUNNING and STOPPED instances can be changed.
    • Batch operations are supported. The maximum number of instances in each request is 30.
    • 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: ModifyInstancesBundle.
    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 target instances. You can get the IDs from the InstanceId parameter returned by the DescribeInstances API. Up to 15 instances can be specified at the same time.
    BundleId Yes String ID of bundles to change. You can get the IDs from the BundleId returned by the DescribeBundles.
    AutoVoucher No Boolean Whether to use existing vouchers under the current account automatically. Valid values:
    true: Deduct from existing vouchers automatically
    false: Do not deduct from existing vouchers automatically
    Default value: 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 Changing the Lighthouse instance bundle

    This example shows you how to change the Lighthouse instance bundle.

    Input Example

    POST / HTTP/1.1 
    Host: lighthouse.tencentcloudapi.com 
    Content-Type: application/json 
    X-TC-Action: ModifyInstancesBundle 
    <Common request parameters>
        "InstanceIds": [
        "BundleId": "bundle_gen_lin_01",
        "AutoVoucher": true

    Output Example

        "Response": {
            "RequestId": "3964a892-5399-4eb7-a35b-8bddfe683ab4"

    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.InstanceOperationFailed Failed to manipulate the instance.
    FailedOperation.ModifyInstancesBundleFailed Failed to change the instance bundle.
    InternalError Internal error.
    InvalidParameter.BundleIdNotFound Undefined service package ID.
    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.
    MissingParameter Missing parameter.
    OperationDenied.BundleNotSupportModify This instance does not support upgrading packages.
    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.InvalidInstanceState Unsupported operation: the instance status is invalid.
    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