产品动态
公共镜像更新动态
操作系统官方停止维护计划
产品公告
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.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.
| 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. |
| 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. |
This example shows you how to query the VNC URL of an instance.
GET https://cvm.tencentcloudapi.com/?Action=DescribeInstanceVncUrl
&Region=ap-beijing
&InstanceId=ins-r9hr2upy
&<Common request parameters>
{
"Response": {
"InstanceVncUrl": "wss%3A%2F%2Fbjvnc.qcloud.com%3A26789%2Fvnc%3Fs%3DaHpjWnRVMFNhYmxKdDM5MjRHNlVTSVQwajNUSW0wb2tBbmFtREFCTmFrcy8vUUNPMG0wSHZNOUUxRm5PMmUzWmFDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9",
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidInstance.NotSupported | This instance is not supported. |
| 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 are entering the rescue mode, and this operation is not supported. |
| UnsupportedOperation.InstanceStateEnterServiceLiveMigrate | The instance ins-xxxxxx in the ENTER_SERVICE_LIVE_MIGRATE status is not supported. |
| UnsupportedOperation.InstanceStateExitRescueMode | Instances are exiting from the rescue mode, and this operation is not supported. |
| UnsupportedOperation.InstanceStateExitServiceLiveMigrate | The instance ins-xxxxxx in the EXIT_SERVICE_LIVE_MIGRATE status is not supported. |
| UnsupportedOperation.InstanceStatePending | The instances are being created, and this operation is not supported. |
| UnsupportedOperation.InstanceStateRebooting | The instances are being restarted, and this operation is not supported. |
| UnsupportedOperation.InstanceStateShutdown | Isolated instances do not support this operation. |
| UnsupportedOperation.InstanceStateStarting | The instance is starting up, and this operation is not supported. |
| UnsupportedOperation.InstanceStateStopped | The instance has been shut down, and this operation is not supported. |
| UnsupportedOperation.InstanceStateStopping | The instance is being shut down, and this operation is not supported. |
| UnsupportedOperation.InstanceStateTerminated | Terminated instances are not supported. |
| UnsupportedOperation.InstanceStateTerminating | The instance is being terminated, and the operation is not supported. |
| UnsupportedOperation.SpecialInstanceType | This special instance type does not support the operation. |
| UnsupportedOperation.StoppedModeStopCharging | The instance does not support the no charges when shut down feature. |
文档反馈