Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to query the URL for VNC login.
STOPPED
CVMs.InstanceVncUrl
: Its value will be returned after the API is successfully called.InstanceVncUrl
, you need to append InstanceVncUrl=xxxx
to the end of the link https://img.qcloud.com/qcloud/app/active_vnc/index.html?
.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.
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. |
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.
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceVncUrl
<Common request parameters>
{
"InstanceId": "lhins-ruy9d2tw"
}
{
"Response": {
"InstanceVncUrl": "wss%3A%2F%2Fusevnc.qcloud.com%3A443%2Fvnc%3Fs%3DTnVQUEpVYkc4eUMvMEkyUERKUjhRbzJhbGcyWHFaWmVMU1dRbUQwd0hVVHo2WU4wOEpLWjlQd0JVSWQwUXZOK2FDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9%26password%3D%26isWindows%3Dfalse%26isUbuntu%3Dfalse",
"RequestId": "f9f6fa33-679c-40ea-bb30-b1e9a8989305"
}
}
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 |
---|---|
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. |
Was this page helpful?