GetSessionConnectionData - Gestor de sesiones NICE DCV

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

GetSessionConnectionData

Obtiene información de conexión para la conexión de un usuario específico a una sesión de NICE DCV específica.

Parámetros de solicitud

SessionId

El ID de sesión de la que se puede ver información de conexión.

Tipo: String

Obligatorio: sí

User

Nombre del usuario del que se puede ver la información de conexión.

Tipo: String

Obligatorio: sí

Parámetros de respuesta

Id

El ID único de la sesión.

Name

El nombre de la sesión.

Owner

El propietario de la sesión.

Server

Información sobre el servidor en el que se ejecuta la sesión. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

Ip

Dirección IP del anfitrión del servidor de NICE DCV.

Hostname

El nombre de host del servidor NICE DCV.

Port

El puerto a través del cual el servidor NICE DCV se comunica con los clientes de NICE DCV.

Endpoints

Información sobre los extremos del servidor NICE DCV. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

IpAddress

Dirección IP del punto de conexión del servidor.

Port

El puerto del punto de conexión del servidor.

Protocol

Protocolo utilizado por el punto de conexión del servidor. Entre los valores posibles se incluyen:

  • HTTP— El punto final utiliza el protocolo WebSocket (TCP).

  • QUIC— El punto final utiliza el protocolo QUIC (UDP).

WebUrlPath

La ruta URL web del extremo del servidor. Disponible solo para el protocolo HTTP.

WebUrlPath

La ruta al archivo de configuración del servidor NICE DCV.

Tags

Las etiquetas asignadas al servidor. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

Key

La clave de la etiqueta.

Value

El valor de la etiqueta.

Type

El tipo de sesión.

State

El estado actual de la sesión. Los valores posibles son los siguientes:

  • CREATING- el Broker está en proceso de crear la sesión.

  • READY- la sesión está lista para aceptar conexiones de clientes.

  • DELETING- se está eliminando la sesión.

  • DELETED- se ha eliminado la sesión.

  • UNKNOWN- no se puede determinar el estado de la sesión. Es posible que el corredor y el agente no puedan comunicarse.

CreationTime

La fecha y hora de creación de la sesión.

LastDisconnectionTime

La fecha y hora de desconexión del cliente por última vez.

NumOfConnections

El número de conexiones simultáneas que el usuario tiene a la sesión.

ConnectionToken

El token de autenticación utilizado para conectarse a la sesión.

Información adicional

La información obtenida de esta API se puede pasar a un cliente de NICE DCV para conectarse a la sesión de NICE DCV.

En el caso del cliente web NICE DCV, puede crear una URL que se pueda abrir en el navegador. La URL tiene el siguiente formato:

https://{Ip}:{Port}{WebUrlPath}?authToken={ConnectionToken}#{SessionId}.

En el caso del cliente nativo NICE DCV, puede crear una URL con eldcv:// esquema. Cuando se instala el cliente nativo de NICE DCV, se registra en el sistema como controlador dedcv:// las URL. La URL tiene el siguiente formato:

dcv://{Ip}:{Port}{WebUrlPath}?authToken={ConnectionToken}#{SessionId}.
nota

Si utiliza Amazon EC2, la dirección IP debe ser la pública. Si su configuración tiene servidores NICE DCV detrás de una puerta de enlace, especifique la dirección de la puerta de enlace en lugar de la que devuelve la SessionConnectionData API.

Ejemplo

Python
Solicitud

En el ejemplo siguiente se obtiene la información de conexión de un usuario con un nombre de usuariouser1 y una sesión con un ID desessionId12345.

def get_session_connection_api(): api_instance = swagger_client.GetSessionConnectionDataApi(swagger_client.ApiClient(get_client_configuration())) set_request_headers(api_instance.api_client) return api_instance def get_url_to_connect(api_response): ip_address = api_response.session.server.ip port = api_response.session.server.port web_url_path = api_response.session.server.web_url_path connection_token = api_response.connection_token session_id = api_response.session.id url = f'https://{ip_address}:{port}{web_url_path}?authToken={connection_token}#{session_id}' return url def get_session_connection_data(session_id, user): api_response = get_session_connection_api().get_session_connection_data(session_id=session_id, user=user) url_to_connect = get_url_to_connect(api_response) print('Get Session Connection Data Response:', api_response) print('URL to connect: ', url_to_connect) def main(): get_session_connection_data('sessionId12345', 'user1')
Respuesta

A continuación, se muestra el resultado de este ejemplo.

{ "Session": { "Id": "sessionId12345", "Name": "a session name", "Owner": "an owner 1890", "Server": { "Ip": "1.1.1.123", "Hostname": "server hostname", "Port": "1222", "endpoints": [ { "port": 8443, "web_url_path": "/", "protocol": "HTTP" }, { "port": 9443, "web_url_path": "/", "protocol": "HTTP" }, { "port": 8443, "web_url_path": "", "protocol": "QUIC" } ], "WebUrlPath": "/path", "Tags": [ { "Key": "os", "Value": "windows" }, { "Key": "ram", "Value": "4gb" } ] }, "Type": "VIRTUAL", "State": "UNKNOWN", "CreationTime": "2020-10-06T10:15:31.633Z", "LastDisconnectionTime": "2020-10-06T10:15:31.633Z", "NumOfConnections": 2 }, "ConnectionToken": "EXAMPLEiOiJmOWM1YTRhZi1jZmU0LTQ0ZjEtYjZlOC04ZjY0YjM4ZTE2ZDkiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJkY3ZTZXNzaW9uSWQiOiJTZXNzaW9uSWQxODk5IiwiZGN2U2Vzc2lvbk93bmVyIjoiYW4gb3duZXIgMTEXAMPLEmRjdlNlc3Npb25Vc2VyIjoibXlVc2VyIiwiZXhwIjoxNjAxOTg1NDA4LCJpYXQiOjE2MDE5ODE4MDgsImp0aSI6IjgwMjljNDUwLTQwMDUtNDJhMy04YTQzLWFmZTM3ZTc4NTQ0ZCJ9.N0RRRT1FZuBgex_0iFwKBAdHdM2JSSADc-tngiKXevUxhhJvm3BPJYRs9NPE4GCJRTc13EXAMPLEIxNEPPh5IMcVmROfU1WKPnry4ypPTp3rsZ7YWjCTSfs1GoN3R_nLFyAxfhPD2yY-Kqtpd5GH0D-E8FwsedV-Q2bRQ4y9y1q0MgFU4QjaSMypUuYR0YjkCaoainjmEZew4A33fG40wATrBvoivBiNWdNpytHX2CDOuk_k0k_DWeZjMvv9jF1f5EXAMPLEm9h5zj_Nb1PKKfBSx9_O6gSJwC9UD-h_GaMgHmltqBIA4jdPD7i0CmC2e7413KFy-EQ4Ej1cM7RjLwhFuWpKWAVJxogJjYpfoKKaPo4KxvJjJIPYhkscklINQpe2W5rnlxCq7sC7ptcGw17DUobP7egRv9H37VD8SrkLyq-hK1G4G8erHvl9HIrTR9_c884fNrTCC8DvC062e4KYdLkAhhJmboN9CAGIGFyd2c1AY_CzzvDL0EXAMLE" }