tencent cloud



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

    1. API Description

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

    This API is used to query the URL for VNC login.

    • It does not support STOPPED CVMs.
    • A VNC URL is only valid for 15 seconds. If you do not access the URL within 15 seconds, you will need to query another one.
    • The VNC URL can be used once only. You need to query a new one if you want to log in again.
    • Up to 30 re-connection attempts allowed in one minute.
    • InstanceVncUrl: Its value will be returned after the API is successfully called.
      After you get the value of InstanceVncUrl, you need to append InstanceVncUrl=xxxx to the end of the link https://img.qcloud.com/qcloud/app/active_vnc/index.html?.
      The final URL can be in the following formats:

    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: DescribeInstanceVncUrl.
    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.
    InstanceId Yes String Instance ID, which can be obtained from the InstanceId returned by the DescribeInstances API.

    3. Output Parameters

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

    4. Example

    Example1 Querying the VNC URL of an instance

    This example shows you how to query the VNC URL of an instance.

    Input Example

    POST / HTTP/1.1
    Host: lighthouse.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeInstanceVncUrl
    <Common request parameters>
        "InstanceId": "lhins-ruy9d2tw"

    Output Example

        "Response": {
            "InstanceVncUrl": "wss%3A%2F%2Fusevnc.qcloud.com%3A443%2Fvnc%3Fs%3DTnVQUEpVYkc4eUMvMEkyUERKUjhRbzJhbGcyWHFaWmVMU1dRbUQwd0hVVHo2WU4wOEpLWjlQd0JVSWQwUXZOK2FDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9%26password%3D%26isWindows%3Dfalse%26isUbuntu%3Dfalse",
            "RequestId": "f9f6fa33-679c-40ea-bb30-b1e9a8989305"

    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
    FailedOperation Operation failed.
    FailedOperation.DescribeInstanceStatus An error occurred when querying the instance status.
    FailedOperation.InstanceOperationFailed Failed to manipulate the instance.
    InternalError.DescribeInstanceStatus Failed to query the instance status. Please try again later.
    InternalError.InvalidCommandNotFound The command is not found.
    InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
    OperationDenied.InstanceCreating It is not allowed to manipulate this instance, as it is being created.
    ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    UnauthorizedOperation.NoPermission No permission
    UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
    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