

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

# GetSessionConnectionData
<a name="GetSessionConnectionData"></a>

Ruft Verbindungsinformationen für die Verbindung eines bestimmten Benutzers zu einer bestimmten Amazon DCV-Sitzung ab. 

**Topics**
+ [Anforderungsparameter](#request)
+ [Antwortparameter](#response)
+ [Zusätzliche Informationen](#additional-info)
+ [Beispiel](#example)

## Anforderungsparameter
<a name="request"></a>

**`SessionId`**  
Die ID der Sitzung, für die Verbindungsinformationen angezeigt werden sollen.  
Typ: Zeichenfolge  
Erforderlich: Ja

**`User`**  
Der Name des Benutzers, für den Verbindungsinformationen angezeigt werden sollen.  
Typ: Zeichenfolge  
Erforderlich: Ja

## Antwortparameter
<a name="response"></a>

**`Id`**  
Die eindeutige ID der Sitzung.

**`Name`**  
Der Name der Sitzung.

**`Owner`**  
Der Besitzer der Sitzung.

**`Server`**  
Informationen über den Server, auf dem die Sitzung läuft. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:    
**`Ip`**  
Die IP-Adresse des Amazon DCV-Serverhosts.  
**`Hostname`**  
Der Hostname des Amazon DCV-Serverhosts.  
**`Port`**  
Der Port, über den der Amazon DCV-Server mit Amazon DCV-Clients kommuniziert.  
**`Endpoints`**  
Informationen zu den Amazon DCV-Serverendpunkten. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:    
**`IpAddress`**  
Die IP-Adresse des Serverendpunkts.  
**`Port`**  
Der Port des Serverendpunkts.  
**`Protocol`**  
Das vom Serverendpunkt verwendete Protokoll. Mögliche Werte sind:  
+ `HTTP`— Der Endpunkt verwendet das WebSocket (TCP-) Protokoll.
+ `QUIC`— Der Endpunkt verwendet das QUIC-Protokoll (UDP).  
**`WebUrlPath`**  
Der Web-URL-Pfad des Serverendpunkts. Nur für das HTTP-Protokoll verfügbar.  
**`WebUrlPath`**  
Der Pfad zur Konfigurationsdatei des Amazon DCV-Servers.  
**`Tags`**  
Die dem Server zugewiesenen Tags. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:    
**`Key`**  
Der Tag-Schlüssel.  
**`Value`**  
Der Tag-Wert.

**`Type`**  
Die Art der Sitzung.

**`State`**  
Der aktuelle Status der Sitzung. Die möglichen Werte sind:  
+ `CREATING`- Der Broker ist dabei, die Sitzung zu erstellen.
+ `READY`- Die Sitzung ist bereit, Client-Verbindungen anzunehmen.
+ `DELETING`- Die Sitzung wird gelöscht.
+ `DELETED`- Die Sitzung wurde gelöscht.
+ `UNKNOWN`- Der Status der Sitzung konnte nicht ermittelt werden. Der Broker und der Agent können möglicherweise nicht kommunizieren.

**`CreationTime`**  
Datum und Uhrzeit der Erstellung der Sitzung.

**`LastDisconnectionTime`**  
Datum und Uhrzeit der letzten Verbindungsunterbrechung des Clients.

**`NumOfConnections`**  
Die Anzahl der gleichzeitigen Verbindungen, die der Benutzer zur Sitzung hat.

**`ConnectionToken`**  
Das Authentifizierungstoken, das für die Verbindung mit der Sitzung verwendet wird.

## Zusätzliche Informationen
<a name="additional-info"></a>

Die von dieser API abgerufenen Informationen können an einen Amazon DCV-Client weitergegeben werden, um eine Verbindung zur Amazon DCV-Sitzung herzustellen.

Im Fall des Amazon DCV-Webclients können Sie eine URL erstellen, die im Browser geöffnet werden kann. Die URL hat das folgende Format: 

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

Im Fall des nativen Amazon DCV-Clients können Sie eine URL mit dem `dcv://` Schema erstellen. Wenn der native Amazon DCV-Client installiert ist, registriert er sich beim System als Handler für `dcv://` URLs. Die URL hat das folgende Format: 

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

**Anmerkung**  
 Wenn Sie Amazon EC2 verwenden, sollte die IP-Adresse die öffentliche sein. Wenn Ihre Konfiguration Amazon DCV-Hosts hinter einem Gateway hat, geben Sie die Gateway-Adresse und nicht die von der SessionConnectionData API zurückgegebene Adresse an. 

## Beispiel
<a name="example"></a>

------
#### [ Python ]

**Anforderung**  
Im folgenden Beispiel werden Verbindungsinformationen für einen Benutzer mit dem Benutzernamen von `user1` und einer Sitzung mit der ID von `sessionId12345` abgerufen. 

```
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')
```

**Antwort**  
Das Folgende ist die Beispielausgabe.

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

------