GetSessionConnectionData - Manajer DCV Sesi Amazon
Permintaan parameterParameter responsInfo tambahanContoh

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

GetSessionConnectionData

Mendapat informasi koneksi untuk koneksi pengguna tertentu ke DCV sesi Amazon tertentu.

Permintaan parameter

SessionId

ID sesi untuk melihat informasi koneksi.

Tipe: String

Diperlukan: Ya

User

Nama pengguna untuk melihat informasi koneksi.

Tipe: String

Diperlukan: Ya

Parameter respons

Id

ID unik sesi.

Name

Nama sesi.

Owner

Pemilik sesi.

Server

Informasi tentang server tempat sesi berjalan. Struktur data ini mencakup parameter respons bersarang berikut:

Ip

Alamat IP dari host DCV server Amazon.

Hostname

Nama host dari host DCV server Amazon.

Port

Port tempat DCV server Amazon berkomunikasi dengan DCV klien Amazon.

Endpoints

Informasi tentang titik akhir DCV server Amazon. Struktur data ini mencakup parameter respons bersarang berikut:

IpAddress

Alamat IP dari endpoint server.

Port

Port dari endpoint server.

Protocol

Protokol yang digunakan oleh endpoint server. Nilai yang mungkin termasuk:

  • HTTPEndpoint menggunakan protokol WebSocket (TCP).

  • QUICEndpoint menggunakan protokol QUIC (UDP).

WebUrlPath

URLJalur web dari titik akhir server. Hanya tersedia untuk HTTP protokol.

WebUrlPath

Jalur ke file konfigurasi DCV server Amazon.

Tags

Tag yang ditetapkan ke server. Struktur data ini mencakup parameter respons bersarang berikut:

Key

Kunci tanda.

Value

Nilai tanda.

Type

Jenis sesi.

State

Keadaan sesi saat ini. Kemungkinan nilainya adalah:

  • CREATING- Broker sedang dalam proses membuat sesi.

  • READY- sesi siap menerima koneksi klien.

  • DELETING- sesi sedang dihapus.

  • DELETED- sesi telah dihapus.

  • UNKNOWN- tidak dapat menentukan status sesi. Broker dan Agen mungkin tidak dapat berkomunikasi.

CreationTime

Tanggal dan waktu sesi dibuat.

LastDisconnectionTime

Tanggal dan waktu pemutusan klien terakhir.

NumOfConnections

Jumlah koneksi bersamaan yang dimiliki pengguna ke sesi.

ConnectionToken

Token otentikasi yang digunakan untuk terhubung ke sesi.

Info tambahan

Informasi yang diperoleh dari ini API dapat diteruskan ke DCV klien Amazon untuk terhubung ke DCV sesi Amazon.

Dalam kasus klien DCV Web Amazon, Anda dapat membuat URL yang dapat dibuka di browser. Ini URL memiliki format berikut: 

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

Dalam kasus klien DCV asli Amazon, Anda dapat membangun URL dengan dcv:// skema. Ketika klien DCV asli Amazon diinstal, ia mendaftarkan dirinya dengan sistem sebagai penangan untuk. dcv:// URLs Ini URL memiliki format berikut: 

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

Jika Anda menggunakan AmazonEC2, alamat IP harus menjadi alamat publik. Jika konfigurasi Anda memiliki DCV host Amazon di belakang gateway, tentukan alamat gateway daripada yang dikembalikan oleh SessionConnectionData API.

Contoh

Python
Permintaan

Contoh berikut mendapatkan informasi koneksi untuk pengguna dengan nama pengguna user1 dan sesi dengan ID darisessionId12345. 

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

Berikut ini adalah output sampel.

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