Last updated: 2020-03-16 18:27:27

1. API Description

Domain name for API request:

This API is used to query the VNC URL of an instance.

  • It does not support STOPPED CVMs.

  • A VNC URL is only valid for 15 sec. If you do not access the URL within 15 seconds, it will become invalid and you will have to query another one.

  • Once you access a VNC URL, it will become invalid and you will have to query another one.

  • If the connection breaks up, you can make up to 30 requests per minute to reestablish the connection.

  • After you get the value of InstanceVncUrl, you need to append InstanceVncUrl=xxxx to the end of the link

    • Parameter InstanceVncUrl: the value of InstanceVncUrl returned after a successful API call.

      The final URLs are in the following format:

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

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 parameter. The value used for this API: DescribeInstanceVncUrl.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID. To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response.

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 how to query the VNC URL of an instance.

Input Example

&<common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


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
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.
InvalidInstanceState This operation cannot be performed due to the current instance status.