翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

特定のユーザーによる特定の Amazon DCV セッションへの接続に関する接続情報を取得します。

**Topics**
+ [リクエストパラメータ](#request)
+ [レスポンスパラメータ](#response)
+ [追加情報](#additional-info)
+ [例](#example)

## リクエストパラメータ
<a name="request"></a>

**`SessionId`**  
接続情報が表示されるセッションの ID。  
タイプ: 文字列  
必須: はい

**`User`**  
接続情報が表示されるユーザーの名前。  
タイプ: 文字列  
必須: はい

## レスポンスパラメータ
<a name="response"></a>

**`Id`**  
セッションの一意の ID。

**`Name`**  
セッションの名前。

**`Owner`**  
セッションの所有者。

**`Server`**  
セッションが実行されているサーバーに関する情報。このデータ構造には、次のネスト済みレスポンスパラメータが含まれます。    
**`Ip`**  
Amazon DCV サーバーホストの IP アドレス。  
**`Hostname`**  
Amazon DCV サーバーホストのホスト名。  
**`Port`**  
Amazon DCV サーバーが Amazon DCV クライアントと通信するポート。  
**`Endpoints`**  
Amazon DCV サーバーのエンドポイントに関する情報。このデータ構造には、次のネスト済みレスポンスパラメータが含まれます。    
**`IpAddress`**  
サーバーエンドポイントの IP アドレス。  
**`Port`**  
サーバーエンドポイントのポート。  
**`Protocol`**  
サーバーエンドポイントで使用されるプロトコル。可能な値は以下のとおりです:  
+ `HTTP` — エンドポイントでは WebSocket (TCP) プロトコルが使用されます。
+ `QUIC` — エンドポイントでは QUIC (UDP) プロトコルが使用されます。  
**`WebUrlPath`**  
サーバーエンドポイントのウェブ URL パス。HTTP プロトコルでのみ使用できます。  
**`WebUrlPath`**  
Amazon DCV サーバーの設定ファイルへのパス。  
**`Tags`**  
サーバーに割り当てられているタグ。このデータ構造には、次のネスト済みレスポンスパラメータが含まれます。    
**`Key`**  
タグキー。  
**`Value`**  
タグ値。

**`Type`**  
セッションのタイプ。

**`State`**  
セッションの現在の状態。可能な値は以下のとおりです。  
+ `CREATING` — ブローカーでセッションが作成されています。
+ `READY` — セッションはクライアント接続を受け入れる準備が整っている状態です。
+ `DELETING` — セッションが削除されています。
+ `DELETED` — セッションが削除されました。
+ `UNKNOWN` — セッションの状態を判別できません。ブローカーとエージェントが通信できない可能性があります。

**`CreationTime`**  
セッションが作成された日時。

**`LastDisconnectionTime`**  
クライアントが最後に切断された日時。

**`NumOfConnections`**  
ユーザーが持つ同時セッション接続の数。

**`ConnectionToken`**  
セッションへの接続に使用されている認証トークン。

## 追加情報
<a name="additional-info"></a>

この API から取得した情報は、Amazon DCV セッションに接続するために Amazon DCV クライアントに渡すことができます。

Amazon DCV ウェブクライアントの場合は、ブラウザで開くことができる URL を作成できます。URL は以下の形式です。

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

Amazon DCV ネイティブクライアントの場合は、`dcv://` スキーマを使用して URL を作成できます。Amazon DCV ネイティブクライアントをインストールすると、`dcv://` URL のハンドラーとしてシステムに登録されます。URL は以下の形式です。

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

**注記**  
 Amazon EC2 を使用している場合、IP アドレスはパブリックアドレスである必要があります。ゲートウェイの背後に Amazon DCV ホストが設定されている場合は、SessionConnectionData API によって返されるアドレスではなく、ゲートウェイのアドレスを指定してください。

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

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

**[リクエスト]**  
次の例では、ユーザー名が `user1` であるユーザーと、ID が `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')
```

**[応答]**  
以下は出力例です。

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

------