Obtaining a VNC-based Remote Login Address (Microversion 2.6 or Later)
Function
This API is used to obtain the address for remotely logging in to an ECS using VNC.
URI
POST /v2.1/{project_id}/servers/{server_id}/remote-consoles
Parameter |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. |
server_id |
Yes |
Specifies the ECS ID. |
Constraints
- When using this API, ensure that the microversion is 2.6 or later.
Add a microversion using the HTTP request header X-OpenStack-Nova-API-Version or OpenStack-API-Version.
For example, X-OpenStack-Nova-API-Version: 2.6 or OpenStack-API-Version: compute 2.6
- An obtained login address is valid for 10 minutes. Obtain a new one after expiration.
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
remote_console |
Yes |
Object |
Obtains the address for remotely logging in to an ECS using VNC. For details, see Table 3. |
Response
Table 4 describes the response parameters.
Parameter |
Type |
Description |
---|---|---|
remote_console |
Object |
Obtains the address for remotely logging in to an ECS. For details, see Table 5. |
Example Request
Obtain the VNC login address of a specified ECS.
POST https://{endpoint}/v2.1/13c67a214ced4afb88d911ae4bd5721a/servers/47bc79ae-df61-4ade-9197-283a74e5d70e/remote-consoles { "remote_console" : { "type" : "novnc", "protocol": "vnc" } }
Example Response
{ "remote_console": { "url": "https://nova-novncproxy.az21.dc1.domainname.com:8002/vnc.auto.html?token=80fa7c8d-37fe-451e-8b08-bfbd9fb6a4df&lang=EN", "type": "novnc", "protocol": "vnc" } }
Returned Values
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot