Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

DescribeInstanceVncUrl

Last updated: 2023-08-18 14:28:09

Download PDF

1. API Description

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

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

A maximum of 20 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: 2019-07-19.
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` field in the returned value of 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 instance

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribeInstanceVncUrl
&InstanceId=ein-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

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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.InternalOperationFailure	Internal error.
InvalidParameter.InvalidDataFormat	The data format is incorrect.
MissingParameter.MissingInstancesParameter	The instance operation parameters are incomplete.
OperationDenied.InstanceOperationInProgress	The current operation is not allowed.
ResourceNotFound	The resource does not exist.
UnsupportedOperation	Unsupported operation.
UnsupportedOperation.InvalidInstanceState	This operation cannot be performed in the current status.

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

tencent cloud

Recent Pages

DescribeInstanceVncUrl

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the VNC URL of instance

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeInstanceVncUrl

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the VNC URL of instance

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?