GetSessionScreenshots - Manajer Sesi Amazon DCV
Permintaan parameterParameter responsContoh

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

GetSessionScreenshots

Mendapat tangkapan layar dari satu atau lebih sesi Amazon DCV.

Untuk memodifikasi format gambar, konfigurasikan session-screenshot-format parameter pada konfigurasi Broker Manajer Sesi. Lihat File konfigurasi Broker di Panduan Administrator Manajer Sesi Amazon DCV.

Ketika MaxHeight parameter MaxWidth atau GetSessionScreenshots permintaan tidak ditentukan, session-screenshot-max-height nilai session-screenshot-max-width dan yang ditetapkan dalam file konfigurasi Broker Manajer Sesi akan digunakan. Untuk mengubah parameter tersebut, lihat juga file konfigurasi Broker di Panduan Administrator Manajer Sesi Amazon DCV.

Nilai atas untuk resolusi tangkapan layar terbatas pada resolusi sesi jarak jauh. Jika MaxHeight parameter MaxWidth dan diatur ke nilai yang lebih tinggi dari resolusi sesi jarak jauh saat ini, tangkapan layar yang dihasilkan akan terbatas pada resolusi sesi yang sebenarnya.

catatan

Untuk mengubah nilai ini dari Access Console, lihat file konfigurasi Klien Web di Panduan Administrator Konsol Akses Amazon DCV. Untuk mengubah nilai ini dengan CLI Session Manager, lihat get-session-screenshots di Panduan CLI Amazon DCV.

Permintaan parameter

SessionId

ID sesi Amazon DCV untuk mendapatkan tangkapan layar.

Tipe: String

Diperlukan: Ya

MaxWidth

Lebar maksimum, dalam piksel, tangkapan layar sesi. Jika tidak ditentukan, nilai dari konfigurasi Broker Manajer Sesi akan berlaku. Jika disediakan, ini harus angka yang lebih besar dari 0.

Tipe: Integer

Wajib: Tidak

MaxHeight

Ketinggian maksimum, dalam piksel, tangkapan layar sesi. Jika tidak ditentukan, nilai dari konfigurasi Broker Manajer Sesi akan berlaku. Jika disediakan, ini harus angka yang lebih besar dari 0.

Jenis: Integer

Wajib: Ya

Parameter respons

RequestId

ID unik dari permintaan.

SuccessfulList

Informasi tentang tangkapan layar yang sukses. Struktur data ini mencakup parameter respons bersarang berikut:

SessionScreenshot

Informasi tentang tangkapan layar. Struktur data ini mencakup parameter respons bersarang berikut:

SessionId

ID sesi Amazon DCV dari mana tangkapan layar diambil.

Images

Informasi tentang gambar. Struktur data ini mencakup parameter respons bersarang berikut:

Format

Format gambar. Nilai yang mungkin meliputi: jpeg danpng.

Data

Format gambar screenshot base64 yang dikodekan.

CreationTime

Tanggal dan waktu tangkapan layar diambil.

Primary

Menunjukkan apakah tangkapan layar adalah tampilan utama sesi Amazon DCV.

UnsuccessfulList

Informasi tentang tangkapan layar yang gagal. Struktur data ini mencakup parameter respons bersarang berikut:

GetSesionScreenshotRequestData

Permintaan asli yang gagal.

SessionId

ID sesi Amazon DCV dari mana tangkapan layar akan diambil.

FailureReason

Sebab kegagalan.

GetSessionScreenshotRequestData

Permintaan asli yang gagal.

Contoh

Python
Permintaan

Contoh berikut mendapatkan tangkapan layar dari dua sesi (sessionId1dansessionId2) dengan lebar maks ditetapkan pada 800 dan tinggi maks ditetapkan pada 600. Sesi sessionId2 tidak ada dan mengakibatkan kegagalan.

from swagger_client.models.describe_servers_request_data import GetSessionScreenshotRequestData

def get_sessions_api():
    api_instance = swagger_client.ServersApi(swagger_client.ApiClient(get_client_configuration()))
    set_request_headers(api_instance.api_client)
    return api_instance

def get_session_screenshots(session_ids, max_width=None, max_height=None):
    request = [GetSessionScreenshotRequestData(session_id=session_id, max_width=max_width, max_height=max_height) for session_id in session_ids]
    print('Get Session Screenshots Request:', request)
    api_instance = get_sessions_api()
    api_response = api_instance.get_session_screenshots(body=request)
    print('Get Session Screenshots Response:', api_response)

def main():
    get_session_screenshots(["sessionId1", "sessionId2"]), 800, 600)
Respons

Berikut ini adalah output sampel.

{
    "RequestId": "542735ef-f6ab-47d8-90e5-23df31d8d166",
    "SuccessfulList": [
        {
            "SessionScreenshot": {
                "SessionId": "sessionId1",
                "Images": [
                    {
                        "Format": "png",
                        "Data": "iVBORw0KGgoAAAANSUhEUgAAAEXAMPLE",
                        "CreationTime": "2021-03-30T15:47:06.822Z",
                        "Primary": true
                    }
                ]
            }
        }
    ],
    "UnsuccessfulList": [
        {
            "GetSessionScreenshotRequestData": {
                "SessionId": "sessionId2"
            },
            "FailureReason": "Dcv session not found."
        }
    ]
}