GetSessionScreenshots

Obtiene capturas de pantalla de una o más sesiones de NICE DCV.

El tipo de archivo de imagen y la resolución de la captura de pantalla dependen de la configuración de Session Manager Broker. Para modificar el tipo de archivo de imagen, configure elsession-screenshot-format parámetro. Para modificar la resolución, configure lossession-screenshot-max-height parámetrossession-screenshot-max-width y. Para obtener más información, consulte el archivo de configuración del bróker en la Guía del administrador de sesiones de NICE DCV.

Parámetros de solicitud

SessionId

El ID de la sesión de NICE DCV de la que se obtiene la captura de pantalla.

Tipo: cadena

Obligatorio: sí

Parámetros de respuesta

RequestId

El ID único de la solicitud.

SuccessfulList

Información sobre las capturas de pantalla exitosas. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

SessionScreenshot

Información sobre las capturas de pantalla. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

SessionId

El ID de la sesión de NICE DCV de la que se tomó la captura de pantalla.

Images

: información acerca de las imágenes. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

Format

Formato de la imagen. Los valores posibles incluyen:jpeg ypng.

Data

La imagen de captura de pantalla en formato codificado en base64.

CreationTime

La fecha y hora en que se realizó la captura de pantalla.

Primary

Indica si la captura de pantalla es de la pantalla principal de la sesión NICE DCV.

UnsuccessfulList

Información sobre las capturas de pantalla fallidas. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

GetSesionScreenshotRequestData

La solicitud original que falló.

SessionId

El ID de la sesión de NICE DCV de la que se iba a tomar la captura de pantalla.

FailureReason

El motivo del error.

Ejemplo

Python

Solicitud

En el siguiente ejemplo se obtienen capturas de pantalla de dos sesiones (sessionId1ysessionId2). sessionId2La sesión no existe y se produce un error.

from swagger_client.models.describe_servers_request_data import DescribeServersRequestData

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):
    request = [GetSessionScreenshotRequestData(session_id=session_id) 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"])

Respuesta

A continuación, se muestra el resultado de este ejemplo.

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