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 la sesión de la que se va a ver la información de conexión.
Tipo: cadena
Obligatorio: sí
User-
El nombre del usuario del que se va a ver la información de conexión.
Tipo: cadena
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 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 NICE DCV.
Endpoints-
Información sobre los terminales del servidor NICE DCV. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:
IpAddress-
Dirección IP del punto de enlace del servidor.
Port-
El puerto del punto de enlace del servidor.
Protocol-
Protocolo utilizado por el punto de enlace del servidor. Entre los valores posibles se incluyen:
-
HTTP— El punto final usa el protocolo WebSocket (TCP). -
QUIC— El terminal usa el protocolo QUIC (UDP).
-
WebUrlPath-
La ruta URL web del punto final 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-
Fecha y hora en que se desconectó el 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 de 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}.
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 devuelta por la SessionConnectionData API.
Ejemplo
