tencent cloud



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

    1. API Description

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

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

    A maximum of 5 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: CreateInstances.
    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.
    BundleId Yes String Bundle ID. You can get it via the DescribeBundles API.
    BlueprintId Yes String Image ID. You can get it via the DescribeBlueprints API.
    InstanceChargePrepaid Yes InstanceChargePrepaid Monthly subscription information for the instance, including the purchase period, setting of auto-renewal, etc.
    InstanceName No String Instance display name.
    InstanceCount No Integer Number of the instances to purchase. For monthly subscribed instances, the value can be 1 to 30. The default value is 1. Note that this number can not exceed the remaining quota under the current account.
    Zones.N No Array of String List of availability zones. A random AZ is selected by default.
    DryRun No Boolean Whether the request is a dry run only.
    true: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available.
    If the dry run fails, the corresponding error code will be returned.
    If the dry run succeeds, the RequestId will be returned.
    false (default value): send a normal request and create instance(s) if all the requirements are met.
    ClientToken No String A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idem-potency of the request cannot be guaranteed.
    LoginConfiguration No LoginConfiguration Login password of the instance. It’s only available for Windows instances. If it’s not specified, it means that the user choose to set the login password after the instance creation.
    Containers.N No Array of DockerContainerConfiguration Configuration of the containers to create
    AutoVoucher No Boolean Whether to use the vouchers automatically. It defaults to No.

    3. Output Parameters

    Parameter Name Type Description
    InstanceIdSet Array of String List of IDs created by using this API. The returning of IDs does not mean that the instances are created successfully.

    You can call DescribeInstances API, and find the instance ID in the InstancesSet returned to check its status. If the status is running, the instance is created successfully.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a Lighthouse instance

    This example shows how to create a monthly subscribed Lighthouse instance.

    Input Example

    POST / HTTP/1.1
    Host: lighthouse.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateInstances
    <Common request parameters>
        "BundleId": "bundle_gen_03",
        "BlueprintId": "lhbp-g0tn7djh",
        "InstanceChargePrepaid": {
            "Period": "1",
            "RenewFlag": "NOTIFY_AND_MANUAL_RENEW"

    Output Example

        "Response": {
            "InstanceIdSet": [
            "RequestId": "232b2817-ec08-43f3-8d78-41b1bfb6082c"

    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.InvalidRegion This region is not open yet. Please select another one.
    FailedOperation Operation failed.
    FailedOperation.CreateInstancesFailed Failed to create the instance.
    FailedOperation.UnableToCreateInstances Failed to create the instance
    InternalError Internal error.
    InternalError.InvalidActionNotFound Failed to find this API
    InvalidParameter Incorrect parameter.
    InvalidParameter.BundleAndBlueprintNotMatch The package and the image do not match.
    InvalidParameter.BundleIdNotFound Undefined service package ID.
    InvalidParameterValue.BlueprintId The image ID is invalid, as instance reinstallation does not allow switching the OS type.
    InvalidParameterValue.BlueprintIdMalformed Invalid parameter value: the image ID format is invalid.
    InvalidParameterValue.BundleAndBlueprintNotMatch The package and the image do not match.
    InvalidParameterValue.BundleNotSupportBlueprintPlatform The selected package does not support the OS of the image.
    InvalidParameterValue.ClientTokenTooLong The client token is too long.
    InvalidParameterValue.InstanceNameTooLong Invalid parameter value: the length of the instance name exceeds the upper limit.
    InvalidParameterValue.InvalidBlueprintId The image ID is invalid.
    InvalidParameterValue.InvalidBundle Invalid package parameter.
    InvalidParameterValue.InvalidParameterCombination Invalid package combination.
    InvalidParameterValue.InvalidPassword The password in the parameter is invalid.
    InvalidParameterValue.InvalidZone Invalid Zone value.
    InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
    InvalidParameterValue.ZoneInvalid Invalid AZ.
    LimitExceeded Reached the quota limit.
    LimitExceeded.InstanceQuotaLimitExceeded Run out of the instance quota.
    ResourceNotFound.BlueprintIdNotFound The image ID does not exist.
    ResourceNotFound.BlueprintNotFound The specified image does not exist. Please check whether the BlueprintId of the image is correct.
    ResourceUnavailable.BundleUnavailable The package is not available.
    ResourcesSoldOut.PurchaseSourceHasNoBundleConfigs There is no available configuration in the package.
    ResourcesSoldOut.ZonesHasNoBundleConfigs There is no available configuration in the package.
    UnauthorizedOperation.NoPermission No permission
    UnsupportedOperation.InstanceLinuxUnixCreatingNotSupportPassword The password can not be set upon creation of a LinuxUnix instance.
    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