AWaws-samples
Virtual Desktops

Get session states for virtual desktops

Changed on

Retrieves the current state of one or more DCV virtual desktop sessions

get/api/dcv/virtual_desktops/session_state

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Query parameters

session_uuidstring required

Comma-separated list of session UUIDs to check

Headers

X-EDH-USERstring required

SOCA username for authentication

X-EDH-TOKENstring required

SOCA authentication token

Response

Session states retrieved successfully

successboolean required
messageobject required

Dictionary mapping session UUIDs to their state objects

Example response

{
  "success": true,
  "message": {
    "12345678-1234-1234-1234-123456789abc": {
      "state": "running",
      "ssm_ping": "Online",
      "instance_id": "i-0abc123def456",
      "instance_private_ip": "10.0.1.100",
      "instance_private_dns": "ip-10-0-1-100.ec2.internal"
    }
  }
}

Changes

  • v1058396b8f0f1Revision changes
    • breaking

      the / response's property type changed from string to object for status

    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed the pending enum value from the / response property for the response status

    • info

      removed the running enum value from the / response property for the response status

    • info

      removed the stopped enum value from the / response property for the response status

    • info

      removed the stopping enum value from the / response property for the response status

    • info

      removed the terminated enum value from the / response property for the response status

  • v16db97cead8dfRevision changes
    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API