GetSessionConnectionData - Manajer Sesi NICE DCV
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 sesi NICE DCV tertentu.

Permintaan parameter

SessionId

ID sesi untuk melihat informasi koneksi.

Tipe: String

Wajib: Ya

User

Nama pengguna untuk melihat informasi koneksi.

Tipe: String

Wajib: Ya

Parameter respons

Id

ID unik sesi sesi sesi sesi sesi sesi ini.

Name

Nama sesi.

Owner

Pemilik sesi sesi sesi ini.

Server

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

Ip

Alamat IP host server NICE DCV.

Hostname

Hostname dari host server NICE DCV.

Port

Port di mana server NICE DCV berkomunikasi dengan klien NICE DCV.

Endpoints

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

IpAddress

Alamat IP titik akhir server server endpoint server endpoint server endpoint server endpoint server endpoint.

Port

Port titik akhir server server akhir server akhir akhir server titik akhir server titik akhir server endpoint.

Protocol

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

  • HTTP- Endpoint menggunakan protokol WebSocket (TCP).

  • QUIC- Endpoint menggunakan protokol QUIC (UDP).

WebUrlPath

Jalur URL web dari titik akhir server. Tersedia untuk protokol HTTP saja.

WebUrlPath

Jalur menuju file konfigurasi server DCV NICE DCV.

Tags

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

Key

Kunci tag.

Value

Nilai tag.

Type

Jenis sesi.

State

Status sesi saat ini sesi sesi sesi sesi sesi sesi sesi sesi sesi ini. Nilai yang mungkin adalah:

  • CREATING- Broker sedang dalam proses pembuatan 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 saat sesi dibuat.

LastDisconnectionTime

Tanggal dan waktu pemutusan klien terakhir.

NumOfConnections

Jumlah koneksi bersamaan pengguna memiliki sesi.

ConnectionToken

Token otentikasi yang digunakan untuk menyambung ke sesi.

Info tambahan

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

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

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

Dalam kasus klien asli NICE DCV, Anda dapat membangun URL dengandcv:// skema. Ketika klien asli NICE DCV diinstal, ia mendaftar sendiri dengan sistem sebagai penangan untukdcv:// URL. URL memiliki format berikut: 

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

Jika Anda menggunakan Amazon EC2, alamat IP haruslah alamat IP publik. Jika konfigurasi Anda memiliki host NICE DCV di belakang gateway, tentukan alamat gateway daripada yang dikembalikan oleh SessionConnectionData API.

Contoh

Python
Permintaan

Contoh berikut mendapat informasi koneksi untuk pengguna dengan nama penggunauser1 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')
Response

Berikut adalah contoh output.

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