GetSessionConnectionData - NICEDCVGestionnaire de sessions
Paramètres de demandeParamètres de réponseInformations supplémentairesExemple

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

GetSessionConnectionData

Obtient les informations de connexion d'un utilisateur spécifique à une NICE DCV session spécifique.

Paramètres de demande

SessionId

ID de la session pour laquelle les informations de connexion doivent être affichées.

Type : String

Obligatoire : oui

User

Nom de l'utilisateur pour lequel les informations de connexion doivent être affichées.

Type : String

Obligatoire : oui

Paramètres de réponse

Id

L'identifiant unique de la session.

Name

Le nom de la session.

Owner

Le propriétaire de la session.

Server

Informations sur le serveur sur lequel s'exécute la session. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

Ip

Adresse IP de l'hôte NICE DCV du serveur.

Hostname

Le nom d'hôte de l'hôte du NICE DCV serveur.

Port

Port par lequel le NICE DCV serveur communique avec les NICE DCV clients.

Endpoints

Informations sur les points de terminaison NICE DCV du serveur. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

IpAddress

Adresse IP du point de terminaison du serveur.

Port

Port du point de terminaison du serveur.

Protocol

Protocole utilisé par le point de terminaison du serveur. Les valeurs possibles incluent :

  • HTTP— Le point de terminaison utilise le protocole WebSocket (TCP).

  • QUIC— Le point de terminaison utilise le protocole QUIC (UDP).

WebUrlPath

Le URL chemin Web du point de terminaison du serveur. Disponible uniquement pour le HTTP protocole.

WebUrlPath

Le chemin d'accès au fichier de configuration du NICE DCV serveur.

Tags

Les balises attribuées au serveur. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

Key

Identification de balise.

Value

Valeur de balise.

Type

Type de session.

State

État actuel de la session. Les valeurs possibles sont :

  • CREATING- le Broker est en train de créer la session.

  • READY- la session est prête à accepter les connexions des clients.

  • DELETING- la session est en cours de suppression.

  • DELETED- la session a été supprimée.

  • UNKNOWN- impossible de déterminer l'état de la session. Le courtier et l'agent peuvent ne pas être en mesure de communiquer.

CreationTime

Date et heure de création de la session.

LastDisconnectionTime

Date et heure de la dernière déconnexion du client.

NumOfConnections

Le nombre de connexions simultanées de l'utilisateur à la session.

ConnectionToken

Le jeton d'authentification utilisé pour se connecter à la session.

Informations supplémentaires

Les informations ainsi obtenues API peuvent être transmises à un NICE DCV client afin de se connecter à la NICE DCV session.

Dans le cas du client NICE DCV Web, vous pouvez en créer un URL qui peut être ouvert dans le navigateur. Le format URL est le suivant : 

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

Dans le cas du client NICE DCV natif, vous pouvez créer un URL avec le dcv:// schéma. Lorsque le client NICE DCV natif est installé, il s'enregistre auprès du système en tant que gestionnaire de dcv://URLs. Le format URL est le suivant : 

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

Si vous utilisez AmazonEC2, l'adresse IP doit être publique. Si votre configuration comporte NICE DCV des hôtes derrière une passerelle, spécifiez l'adresse de la passerelle plutôt que celle renvoyée par le SessionConnectionData API.

Exemple

Python
Demande

L'exemple suivant obtient les informations de connexion d'un utilisateur dont le nom d'utilisateur est user1 et d'une session dont l'ID est égal àsessionId12345. 

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')
Réponse

Voici un exemple de sortie.

{
    "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"
}