Skip to main content
API Explorer|API Explorer
Resource Center/Resource Pool/VM Instance Operations
GETVM Instance OperationsSince 0.6SynchronousAuth Required

GetVmConsoleAddress

GetVmConsoleAddress

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    The VM instance UUID.

Query Parameters

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • hostIpStringRequired

    The IP address of the host where the VM instance is running.

  • portintRequired

    The console port of the VM instance.

  • protocolStringRequired

    The console protocol of the VM instance. Options: vnc spice vncAndSpice

  • successbooleanRequired

    Whether the operation succeeds.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • vdiPortInfovdiPortInfoRequired

    See vdiPortInfo.

    • vncPortIntegerRequired

      The VNC port No.

    • spicePortIntegerRequired

      The SPICE port No.

    • spiceTlsPortIntegerRequired

      If TLS encryption is enabled for SPICE, two ports will be available: spiceTlsPort and spicePort. To connect the VM instance by using a SPICE client, use spiceTlsPort.

Endpoint

GET/zstack/v1/vm-instances/{uuid}/console-addresses

/zstack/v1/vm-instances/{uuid}/console-addresses

Operation ID

GetVmConsoleAddress

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/vm-instances/{uuid}/console-addresses?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "hostIp": "192.168.10.100", "port": 5900.0, "protocol": "vnc", "vdiPortInfo": { "vncPort": 5900.0 } }

Change History

This API has no change history records yet.

View all change history