DescribeServers - Amazon DCV Session Manager
Parámetros de solicitudParámetros de respuestaEjemplo

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeServers

Describe uno o varios servidores Amazon DCV.

Parámetros de solicitud

ServerIds

ID de los servidores Amazon DCV que se van a describir. Si no se especifica un ID, todos los servidores se devuelven en salida paginada.

Tipo: matriz de cadenas

Obligatorio: no

NextToken

Token que se utilizará para recuperar la siguiente página de resultados.

Tipo: cadena

Obligatorio: no

MaxResults

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

Rango válido: de 1 a 1000

Predeterminado: 1000

Tipo: entero

Obligatorio: no

Parámetros de respuesta

RequestId

ID único de la solicitud.

Servers

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

Id

ID exclusivo del servidor Amazon DCV.

Ip

Dirección IP del servidor Amazon DCV.

Hostname

Nombre de host del servidor Amazon DCV.

Endpoints

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

IpAddress

Dirección IP del punto de conexión del servidor.

Port

Puerto del punto de conexión del servidor.

Protocol

Protocolo utilizado por el punto de conexión del servidor. Los valores posibles son:

  • HTTP: el punto de conexión utiliza el protocolo WebSocket (TCP).

  • QUIC: el punto de conexión utiliza el protocolo QUIC (UDP).

WebUrlPath

La ruta URL web del punto de conexión del servidor. Disponible solo para el protocolo HTTP.

Version

Versión del servidor Amazon DCV.

SessionManagerAgentVersion

Versión del agente de Session Manager que se ejecuta en el servidor Amazon DCV.

Availability

Disponibilidad del servidor Amazon DCV. Los valores posibles son:

  • AVAILABLE: el servidor está disponible y listo para la colocación de sesiones.

  • UNAVAILABLE: el servidor no está disponible y no puede aceptar la colocación de sesiones.

UnavailabilityReason

Motivo de la falta de disponibilidad del servidor Amazon DCV. Los valores posibles son:

  • SERVER_FULL: el servidor Amazon DCV ha alcanzado el número máximo de sesiones simultáneas que puede ejecutar.

  • SERVER_CLOSED: el servidor Amazon DCV ha dejado de estar disponible utilizando la API CloseServer.

  • UNREACHABLE_AGENT: el broker de Session Manager no puede comunicarse con el agente de Session Manager en el servidor Amazon DCV.

  • UNHEALTHY_DCV_SERVER: el agente de Session Manager no se puede comunicar con el servidor Amazon DCV.

  • EXISTING_LOGGED_IN_USER: (solo servidores Amazon DCV de Windows) un usuario ha iniciado la sesión actual en el servidor Amazon DCV mediante RDP.

  • UNKNOWN: el broker de Session Manager no puede determinar el motivo.

ConsoleSessionCount

Número de sesiones de consola en el servidor Amazon DCV.

VirtualSessionCount

Número de sesiones virtuales en el servidor Amazon DCV.

Host

Información sobre el servidor host en el que se ejecuta el servidor Amazon 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. Los valores posibles son:

  • 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 Linux) Versión del kernel del sistema operativo.

BuildNumber

(Solo Windows) 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

Memoria total, en bytes, del servidor host.

UsedBytes

Memoria usada, en bytes, del servidor host.

Swap

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

TotalBytes

Tamaño de archivo de intercambio total, en bytes, del servidor host.

UsedBytes

Tamaño de archivo de intercambio usado, en bytes, del servidor host.

Aws

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

Region

Región de AWS de la instancia Amazon EC2.

Ec2InstanceType

Tipo de instancia de Amazon EC2.

Ec2InstanceId

ID de la instancia de Amazon EC2.

Ec2ImageId

ID de la imagen de Amazon EC2.

CpuInfo

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

Vendor

Proveedor de la CPU del servidor host.

ModelName

Modelo de la CPU del servidor host.

Architecture

Arquitectura de la CPU del servidor host.

NumberOfCpus

Número de CPU del servidor host.

PhysicalCorePerCpu

Número de núcleos de CPU por CPU.

CpuLoadAverage

Información sobre la carga de la 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 el último período de 5 minutos.

FifteenMinutes

Carga media de la CPU durante el último período de 15 minutos.

Gpus

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

Vendor

Proveedor de la GPU del servidor host.

ModelName

Modelo de la GPU del servidor host.

LoggedInUsers

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

Username

Nombre de usuario del usuario que ha iniciado sesión.

Tags

Etiquetas asignadas al servicio. 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

En el siguiente ejemplo se describen todos los servidores Amazon 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 la salida de 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"
                }
            ]
        }
    ]
}