DescribeServers

Descreve um ou mais servidores Amazon DCV.

Parâmetros de solicitação

ServerIds

Os IDs servidores Amazon DCV a serem descritos. Se nenhum IDs for especificado, todos os servidores serão retornados na saída paginada.

Tipo: matriz de strings

Obrigatório: Não

NextToken

O token a ser usado para recuperar da próxima página de resultados.

Tipo: String

Obrigatório: Não

MaxResults

O número máximo de resultados a serem retornados por solicitação na saída paginada. Quando esse parâmetro é usado, a solicitação retorna resultados somente o número especificado de resultados em uma única página junto com um elemento de resposta NextToken. Os resultados restantes da solicitação inicial podem ser vistos enviando outra solicitação com o valor NextToken retornado.

Intervalo válido: 1 a 1000

Padrão: 1000

Tipo: inteiro

Obrigatório: não

Parâmetros de resposta

RequestId

O ID exclusivo da solicitação.

Servers

Informações sobre os servidores Amazon DCV. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

Id

O ID exclusivo do servidor Amazon DCV.

Ip

O endereço IP do servidor Amazon DCV.

Hostname

O nome do host do servidor Amazon DCV.

Endpoints

Informações sobre os endpoints do servidor Amazon DCV. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

IpAddress

O endereço IP do endpoint do servidor.

Port

A porta do endpoint do servidor.

Protocol

O protocolo usado pelo endpoint do servidor. Os possíveis valores incluem:

• HTTP— O endpoint usa o protocolo WebSocket (TCP).

• QUIC — O endpoint usa o protocolo QUIC (UDP).

WebUrlPath

O caminho do URL da web do endpoint do servidor. Disponível somente para o protocolo HTTP.

Version

A versão do servidor Amazon DCV.

SessionManagerAgentVersion

A versão do Atendente do Gerenciador de Sessões em execução no servidor Amazon DCV.

Availability

A disponibilidade do servidor Amazon DCV. Os possíveis valores incluem:

• AVAILABLE — O servidor está disponível e pronto para o posicionamento da sessão.

• UNAVAILABLE — O servidor não está disponível e não pode aceitar o posicionamento da sessão.

UnavailabilityReason

O motivo da indisponibilidade do servidor Amazon DCV. Os possíveis valores incluem:

• SERVER_FULL — O servidor Amazon DCV atingiu o número máximo de sessões simultâneas que pode ser executado.

• SERVER_CLOSED— O servidor Amazon DCV ficou indisponível usando a CloseServerAPI.

• UNREACHABLE_AGENT — O Agente do Gerenciador de Sessões não consegue se comunicar com o Atendente do Gerenciador de Sessões no servidor de Amazon DCV.

• UNHEALTHY_DCV_SERVER — O Atendente do Gerenciador de Sessões não consegue se comunicar com o servidor Amazon DCV.

• EXISTING_LOGGED_IN_USER — (Somente servidores Amazon DCV do Windows) Um usuário está conectado no momento ao servidor Amazon DCV usando RDP.

• UNKNOWN — O Agente do Gerenciador de Sessões não consegue determinar o motivo.

ConsoleSessionCount

O número de sessões do console no servidor Amazon DCV.

VirtualSessionCount

O número de sessões virtuais no servidor Amazon DCV.

Host

Informações sobre o servidor host no qual o servidor Amazon DCV está em execução. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

Os

Informações sobre o sistema operacional do servidor host. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

Family

A família do sistema operacional. Os possíveis valores incluem:

• windows — O servidor host está executando um sistema operacional Windows.

• linux — O servidor host está executando um sistema operacional Linux.

Name

O nome do sistema operacional.

Version

A versão do sistema operacional.

KernelVersion

(Somente para Linux) A versão do kernel do sistema operacional.

BuildNumber

(Somente para Windows) O número da compilação do sistema operacional.

Memory

Informações sobre a memória do servidor host. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

TotalBytes

A memória total, em bytes, no servidor host.

UsedBytes

A memória usada, em bytes, no servidor host.

Swap

Informações sobre o arquivo de troca do servidor host. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

TotalBytes

O tamanho total do arquivo de troca, em bytes, no servidor host.

UsedBytes

O tamanho usado do arquivo de troca, em bytes, no servidor host.

Aws

Somente para servidores Amazon DCV em execução em uma EC2 instância da Amazon. AWS-informações específicas. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

Region

A AWS região da EC2 instância da Amazon.

Ec2InstanceType

O tipo de EC2 instância da Amazon.

Ec2InstanceId

O ID da EC2 instância da Amazon.

Ec2ImageId

O ID da EC2 imagem da Amazon.

CpuInfo

Informações sobre o servidor host CPUs. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

Vendor

O fornecedor da CPU do servidor host.

ModelName

O nome do modelo da CPU do servidor host.

Architecture

A arquitetura da CPU do servidor host.

NumberOfCpus

O número de CPUs no servidor host.

PhysicalCorePerCpu

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

CpuLoadAverage

Informações sobre a carga de CPU do servidor host. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

OneMinute

A carga média de CPU durante o último período de 1 minuto.

FiveMinutes

A carga média de CPU durante o último período de 5 minutos.

FifteenMinutes

A carga média de CPU durante o último período de 15 minutos.

Gpus

Informações sobre o servidor host GPUs. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

Vendor

O fornecedor da GPU do servidor host.

ModelName

O nome do modelo da GPU do servidor host.

LoggedInUsers

Os usuários que estão atualmente conectados ao servidor host. Essa estrutura de dados inclui o seguinte parâmetro de resposta aninhada:

Username

O nome de usuário do usuário conectado.

Tags

As tags atribuídas ao servidor. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

Key

A chave de tags.

Value

O valor da tag.

Exemplo

Python

Solicitação

O exemplo a seguir descreve todos os servidores Amazon DCV disponíveis. Os resultados são paginados para mostrar dois 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)

Resposta

Esta é uma saída de exemplo.

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