DescribeInstanceVncUrl

Last updated: 2020-09-17 17:54:20

1. API Description

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

This API is used to query the Virtual Network Console (VNC) URL of an instance for its login to the VNC.

  • 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, it will become invalid and you have to query a URL again.

  • Once the VNC URL is accessed, it will become invalid and you have to query a URL again if needed.

  • If the connection is interrupted, you can make up to 30 reconnection attempts per minute.

  • After getting the value InstanceVncUrl, you need to append InstanceVncUrl=xxxx to the end of the link https://img.qcloud.com/qcloud/app/active_vnc/index.html?.

    • InstanceVncUrl: its value will be returned after the API is successfully called.

      The final URL is in the following format:

https://img.qcloud.com/qcloud/app/active_vnc/index.html?InstanceVncUrl=wss%3A%2F%2Fbjvnc.qcloud.com%3A26789%2Fvnc%3Fs%3DaHpjWnRVMFNhYmxKdDM5MjRHNlVTSVQwajNUSW0wb2tBbmFtREFCTmFrcy8vUUNPMG0wSHZNOUUxRm5PMmUzWmFDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9

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: cvm.ap-shanghai-fsi.tencentcloudapi.com

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

Input Example

GET https://cvm.tencentcloudapi.com/?Action=DescribeInstanceVncUrl
&Region=ap-beijing
&InstanceId=ins-r9hr2upy
&<common request parameters>

Output Example

{
  "Response": {
    "InstanceVncUrl": "wss%3A%2F%2Fbjvnc.qcloud.com%3A26789%2Fvnc%3Fs%3DaHpjWnRVMFNhYmxKdDM5MjRHNlVTSVQwajNUSW0wb2tBbmFtREFCTmFrcy8vUUNPMG0wSHZNOUUxRm5PMmUzWmFDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9",
    "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.

SDK

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.
OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
UnauthorizedOperation.MFAExpired Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid.
UnauthorizedOperation.MFANotFound Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists.
UnsupportedOperation.InstanceStateEnterRescueMode Instances entering the rescue mode do not support this operation.
UnsupportedOperation.InstanceStateExitRescueMode Instances exiting the rescue mode do not support this operation.
UnsupportedOperation.InstanceStateRebooting The restarting instances do not support this operation.
UnsupportedOperation.InstanceStateShutdown The isolated instances do not support this operation.
UnsupportedOperation.InstanceStateStopped The shutdown instances do not support this operation.
UnsupportedOperation.InstanceStateStopping The stopping instances do not support this operation.
UnsupportedOperation.InstanceStateTerminating The terminating instances do not support this operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help