Parámetros de solicitud Parámetros de respuesta Ejemplo

DescribeServers

Describe uno o varios servidores NICE DCV.

Temas

Parámetros de solicitud
Parámetros de respuesta
Ejemplo

Parámetros de solicitud

ServerIds

Los ID de los servidores NICE DCV a describir. Si no se especifica ningún ID, todos los servidores se devuelven en una salida paginada.

Tipo: matriz de cadenas

Obligatorio: no

NextToken

El token que se va a utilizar para recuperar la siguiente página de resultados.

Tipo: cadena

Requerido: No

MaxResults

El número máximo de resultados que devolverá la solicitud en la salida paginada. Cuando se usa este parámetro, la solicitud devuelve solo el número especificado de resultados en una sola página junto con un elemento deNextToken respuesta. Los resultados restantes de la solicitud inicial se pueden ver enviando otra solicitud con elNextToken valor devuelto.

Rango válido: 1-1000

Predeterminado: 1000

Tipo: entero

Obligatorio: no

Parámetros de respuesta

RequestId

El ID único de la solicitud.

Servers

Información sobre los servidores NICE DCV. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

Id

El ID único del servidor NICE DCV.

Ip

Dirección IP del servidor NICE DCV.

Hostname

El nombre de host del servidor NICE DCV.

Endpoints

Información sobre los terminales del servidor NICE DCV. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

IpAddress

Dirección IP del punto de enlace del servidor.

Port

El puerto del punto de enlace del servidor.

Protocol

Protocolo utilizado por el punto de enlace del servidor. Entre los valores posibles se incluyen:

HTTP— El punto final usa el protocolo WebSocket (TCP).
QUIC— El terminal usa el protocolo QUIC (UDP).

WebUrlPath

La ruta URL web del punto final del servidor. Disponible solo para el protocolo HTTP.

Version

La versión del servidor NICE DCV.

SessionManagerAgentVersion

La versión Session Manager Agent que se ejecuta en el servidor NICE DCV.

Availability

La disponibilidad del servidor NICE DCV. Entre los valores posibles se incluyen:

AVAILABLE— El servidor está disponible y listo para la ubicación de la sesión.
UNAVAILABLE— El servidor no está disponible y no puede aceptar la ubicación de la sesión.

UnavailabilityReason

El motivo de la falta de disponibilidad del servidor NICE DCV. Entre los valores posibles se incluyen:

SERVER_FULL— El servidor NICE DCV ha alcanzado el número máximo de sesiones simultáneas que puede ejecutar.
SERVER_CLOSED— El servidor NICE DCV ha dejado de estar disponible mediante la CloseServerAPI.
UNREACHABLE_AGENT— El agente del administrador de sesiones no puede comunicarse con el agente del administrador de sesiones en el servidor NICE DCV.
UNHEALTHY_DCV_SERVER— El agente del administrador de sesiones no puede comunicarse con el servidor NICE DCV.
EXISTING_LOGGED_IN_USER— (Solo servidores NICE DCV de Windows) Actualmente, un usuario ha iniciado sesión en el servidor NICE DCV mediante RDP.
UNKNOWN— El corredor del administrador de sesiones no puede determinar el motivo.

ConsoleSessionCount

El número de sesiones de consola en el servidor NICE DCV.

VirtualSessionCount

El número de sesiones virtuales en el servidor NICE DCV.

Host

Información sobre el servidor host en el que se ejecuta el servidor NICE DCV. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

Os

Información sobre el sistema operativo del servidor host. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

Family

La familia de sistemas operativos. Entre los valores posibles se incluyen:

windows— El servidor host ejecuta un sistema operativo Windows.
linux— El servidor host ejecuta un sistema operativo Linux.

Name

Nombre del sistema operativo.

Version

Versión del sistema operativo.

KernelVersion

(Solo para Linux) Versión del núcleo del sistema operativo.

BuildNumber

(Solo Windows) El número de compilación del sistema operativo.

Memory

Información sobre la memoria del servidor host. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

TotalBytes: La memoria total, en bytes, del servidor host.
UsedBytes: La memoria utilizada, en bytes, en el servidor host.

Swap

Información sobre el archivo de intercambio del servidor host. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

TotalBytes: El tamaño total del archivo de intercambio, en bytes, en el servidor host.
UsedBytes: El tamaño del archivo de intercambio utilizado, en bytes, en el servidor host.

Aws

Solo para servidores NICE DCV que se ejecutan en una instancia de Amazon EC2. AWS-información específica. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

Region: AWSRegión de la instancia de Amazon EC2.
Ec2InstanceType: Tipo de instancia de Amazon EC2.
Ec2InstanceId: El ID de la instancia de Amazon EC2.
Ec2ImageId: El ID de la imagen de Amazon EC2.

CpuInfo

Información sobre las CPU del servidor host. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

Vendor: El proveedor de la CPU del servidor host.
ModelName: El nombre del modelo de la CPU del servidor host.
Architecture: La arquitectura de la CPU del servidor host.
NumberOfCpus: El número de CPU en el servidor host.
PhysicalCorePerCpu: El número de núcleos de CPU por CPU.

CpuLoadAverage

Información sobre la carga de CPU del servidor host. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

OneMinute: Carga media de la CPU durante el último período de 1 minuto.
FiveMinutes: Carga media de la CPU durante los últimos 5 minutos.
FifteenMinutes: Carga media de la CPU durante los últimos 15 minutos.

Gpus

Información sobre las GPU del servidor host. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

Vendor: El proveedor de la GPU del servidor host.
ModelName: El nombre del modelo de la GPU del servidor host.

LoggedInUsers

Los usuarios que han iniciado sesión actualmente en el servidor anfitrión. Esta estructura de datos incluye el siguiente parámetro de respuesta anidado:

Username: El nombre de usuario que ha iniciado sesión.

Tags

Las etiquetas asignadas al servidor. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

Key: La clave de la etiqueta.
Value: El valor de la etiqueta.

Ejemplo

Python

Solicitud

El siguiente ejemplo describe todos los servidores NICE DCV disponibles. Los resultados se paginan para mostrar dos resultados por página.


from swagger_client.models.describe_servers_request_data import DescribeServersRequestData

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

def describe_servers(server_ids=None, next_token=None, max_results=None):
    request = DescribeServersRequestData(server_ids=server_ids, next_token=next_token, max_results=max_results)
    print('Describe Servers Request:', request)
    api_instance = get_servers_api()
    api_response = api_instance.describe_servers(body=request)
    print('Describe Servers Response', api_response)

def main():
    describe_servers(max_results=2)

Respuesta

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


{
    "RequestId": "request-id-123",
    "Servers": [
        {
            "Id": "ServerId123",
            "Ip": "1.1.1.123",
            "Hostname": "node001",
            "DefaultDnsName": "node001",
            "Endpoints": [
                {
                    "IpAddress": "x.x.x.x",
                    "Port": 8443,
                    "WebUrlPath": "/",
                    "Protocol": "HTTP"
                }
            ],
            "Version": "2021.0.10000",
            "SessionManagerAgentVersion": "2021.0.300",
            "Availability": "UNAVAILABLE",
            "UnavailabilityReason": "SERVER_FULL",
            "ConsoleSessionCount": 1,
            "VirtualSessionCount": 0,
            "Host": {
                "Os": {
                    "Family": "windows",
                    "Name": "Windows Server 2016 Datacenter",
                    "Version": "10.0.14393",
                    "BuildNumber": "14393"
                },
                "Memory": {
                    "TotalBytes": 8795672576,
                    "UsedBytes": 1743886336
                },
                "Swap": {
                    "TotalBytes": 0,
                    "UsedBytes": 0
                },
                "Aws": {
                    "Region": "us-west-2b",
                    "EC2InstanceType": "t2.large",
                    "EC2InstanceId": "i-123456789",
                    "EC2ImageId": "ami-12345678987654321"
                },
                "CpuInfo": {
                    "Vendor": "GenuineIntel",
                    "ModelName": "Intel(R) Xeon(R) CPU E5-2676 v3 @ 2.40GHz",
                    "Architecture": "x86_64",
                    "NumberOfCpus": 2,
                    "PhysicalCoresPerCpu": 3
                },
                "CpuLoadAverage": {
                    "OneMinute": 0.04853546,
                    "FiveMinutes": 0.21060601,
                    "FifteenMinutes": 0.18792416
                },
                "Gpus": [],
                "LoggedInUsers": [
                    {
                        "Username": "Administrator"
                    }
                ]
            },
            "Tags": [
                {
                    "Key": "color",
                    "Value": "pink"
                },
                {
                    "Key": "dcv:os-family",
                    "Value": "windows"
                },
                {
                    "Key": "size",
                    "Value": "small"
                },
                {
                    "Key": "dcv:max-virtual-sessions",
                    "Value": "0"
                }
            ]
        },
        {
            "Id": "server-id-12456897",
            "Ip": "1.1.1.145",
            "Hostname": "node002",
            "DefaultDnsName": "node002",
            "Endpoints": [
                {
                    "IpAddress": "x.x.x.x",
                    "Port": 8443,
                    "WebUrlPath": "/",
                    "Protocol": "HTTP"
                },
                {
                    "IpAddress": "x.x.x.x",
                    "Port": 8443,
                    "Protocol": "QUIC"
                }
            ],
            "Version": "2021.0.10000",
            "SessionManagerAgentVersion": "2021.0.0",
            "Availability": "AVAILABLE",
            "ConsoleSessionCount": 0,
            "VirtualSessionCount": 5,
            "Host": {
                "Os": {
                    "Family": "linux",
                    "Name": "Amazon Linux",
                    "Version": "2",
                    "KernelVersion": "4.14.203-156.332.amzn2.x86_64"
                },
                "Memory": {
                    "TotalBytes": 32144048128,
                    "UsedBytes": 2184925184
                },
                "Swap": {
                    "TotalBytes": 0,
                    "UsedBytes": 0
                },
                "Aws": {
                    "Region": "us-west-2a",
                    "EC2InstanceType": "g3s.xlarge",
                    "EC2InstanceId": "i-123456789",
                    "EC2ImageId": "ami-12345678987654321"
                },
                "CpuInfo": {
                    "Vendor": "GenuineIntel",
                    "ModelName": "Intel(R) Xeon(R) CPU E5-2686 v4 @ 2.30GHz",
                    "Architecture": "x86_64",
                    "NumberOfCpus": 4,
                    "PhysicalCoresPerCpu": 2
                },
                "CpuLoadAverage": {
                    "OneMinute": 2.24,
                    "FiveMinutes": 0.97,
                    "FifteenMinutes": 0.74
                },
                "Gpus": [
                    {
                        "Vendor": "NVIDIA Corporation",
                        "ModelName": "GM204GL [Tesla M60]"
                    }
                ],
                "LoggedInUsers": [
                    {
                        "Username" : "user45687"
                    },
                    {
                        "Username" : "user789"
                    }
                ]
            },
            "Tags": [
                {
                    "Key": "size",
                    "Value": "big"
                },
                {
                    "Key": "dcv:os-family",
                    "Value": "linux"
                },
                {
                    "Key": "dcv:max-virtual-sessions",
                    "Value": "10"
                },
                {
                    "Key": "color",
                    "Value": "blue"
                }
            ]
        }
    ]
}

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

CreateSessions

DescribeSessions