1. Interface Description
Interface request domain name: cvm.api3.convergecloud.com.
Used to query the VNC address of an instance.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-04-20 11:36:01.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeInstanceVncUrl |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| InstanceId | Yes | No | String | Queried instance ID, such as ins-38dk3j. Example: ins-r9hr2upy |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| InstanceVncUrl | String | VNC Connection String of User Example: wss%3A%2F%2Fbjvnc.convergecloud.com%3A26789%2Fv |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.