Parametri della richiesta Parametri di risposta Esempio

DescribeServers

Descrive uno o più server Amazon DCV.

Argomenti

Parametri della richiesta
Parametri di risposta
Esempio

Parametri della richiesta

ServerIds

I IDs server Amazon DCV da descrivere. Se non viene specificato alcun IDs valore, tutti i server vengono restituiti in un output impaginato.

Tipo: matrice di stringhe

Campo obbligatorio: no

NextToken

Il token da utilizzare per recuperare la pagina successiva dei risultati.

Tipo: string

Campo obbligatorio: no

MaxResults

Il numero massimo di risultati che la richiesta deve restituire nell'output impaginato. Quando viene utilizzato questo parametro, la richiesta restituisce solo il numero specificato di risultati in una singola pagina insieme a un elemento di NextToken risposta. I risultati rimanenti della richiesta iniziale possono essere visualizzati inviando un'altra richiesta con il NextToken valore restituito.

Intervallo valido: 1 - 1000

Impostazione predefinita: 1000

Tipo: integer

Campo obbligatorio: no

Parametri di risposta

RequestId

L'ID univoco della richiesta.

Servers

Informazioni sui server Amazon DCV. Questa struttura di dati include i seguenti parametri di risposta annidati:

Id

L'ID univoco del server Amazon DCV.

Ip

L'indirizzo IP del server Amazon DCV.

Hostname

Il nome host del server Amazon DCV.

Endpoints

Informazioni sugli endpoint del server Amazon DCV. Questa struttura di dati include i seguenti parametri di risposta annidati:

IpAddress

L'indirizzo IP dell'endpoint del server.

Port

La porta dell'endpoint del server.

Protocol

Il protocollo utilizzato dall'endpoint del server. I valori possibili includono:

HTTP— L'endpoint utilizza il protocollo WebSocket (TCP).
QUIC— L'endpoint utilizza il protocollo QUIC (UDP).

WebUrlPath

Il percorso dell'URL Web dell'endpoint del server. Disponibile solo per il protocollo HTTP.

Version

La versione del server Amazon DCV.

SessionManagerAgentVersion

La versione Session Manager Agent in esecuzione sul server Amazon DCV.

Availability

La disponibilità del server Amazon DCV. I valori possibili includono:

AVAILABLE— Il server è disponibile e pronto per il posizionamento della sessione.
UNAVAILABLE— Il server non è disponibile e non può accettare il posizionamento della sessione.

UnavailabilityReason

Il motivo dell'indisponibilità del server Amazon DCV. I valori possibili includono:

SERVER_FULL— Il server Amazon DCV ha raggiunto il numero massimo di sessioni simultanee che può eseguire.
SERVER_CLOSED— Il server Amazon DCV è stato reso non disponibile utilizzando l'CloseServerAPI.
UNREACHABLE_AGENT— Il broker Session Manager non può comunicare con l'agente Session Manager sul server Amazon DCV.
UNHEALTHY_DCV_SERVER— L'agente Session Manager non può comunicare con il server Amazon DCV.
EXISTING_LOGGED_IN_USER— (Solo server Windows Amazon DCV) Un utente è attualmente connesso al server Amazon DCV tramite RDP.
UNKNOWN— Il broker Session Manager non è in grado di determinarne il motivo.

ConsoleSessionCount

Il numero di sessioni di console sul server Amazon DCV.

VirtualSessionCount

Il numero di sessioni virtuali sul server Amazon DCV.

Host

Informazioni sul server host su cui è in esecuzione il server Amazon DCV. Questa struttura di dati include i seguenti parametri di risposta annidati:

Os

Informazioni sul sistema operativo del server host. Questa struttura di dati include i seguenti parametri di risposta annidati:

Family

La famiglia di sistemi operativi. I valori possibili includono:

windows— Il server host esegue un sistema operativo Windows.
linux— Il server host esegue un sistema operativo Linux.

Name

Il nome del sistema operativo.

Version

La versione del sistema operativo.

KernelVersion

(Solo Linux) La versione del kernel del sistema operativo.

BuildNumber

(Solo Windows) Il numero di build del sistema operativo.

Memory

Informazioni sulla memoria del server host. Questa struttura di dati include i seguenti parametri di risposta annidati:

TotalBytes: La memoria totale, in byte, sul server host.
UsedBytes: La memoria utilizzata, in byte, sul server host.

Swap

Informazioni sul file di swap del server host. Questa struttura di dati include i seguenti parametri di risposta annidati:

TotalBytes: La dimensione totale del file di swap, in byte, sul server host.
UsedBytes: La dimensione del file di swap utilizzato, in byte, sul server host.

Aws

Solo per server Amazon DCV in esecuzione su un' EC2 istanza Amazon. AWS-informazioni specifiche. Questa struttura di dati include i seguenti parametri di risposta annidati:

Region: La AWS regione dell' EC2 istanza Amazon.
Ec2InstanceType: Il tipo di EC2 istanza Amazon.
Ec2InstanceId: L'ID dell' EC2 istanza Amazon.
Ec2ImageId: L'ID dell' EC2 immagine Amazon.

CpuInfo

Informazioni sul server host CPUs. Questa struttura di dati include i seguenti parametri di risposta annidati:

Vendor: Il fornitore della CPU del server host.
ModelName: Il nome del modello della CPU del server host.
Architecture: L'architettura della CPU del server host.
NumberOfCpus: Il numero di CPUs sul server host.
PhysicalCorePerCpu: Il numero di core CPU per CPU.

CpuLoadAverage

Informazioni sul carico della CPU del server host. Questa struttura di dati include i seguenti parametri di risposta annidati:

OneMinute: Il carico medio della CPU nell'ultimo periodo di 1 minuto.
FiveMinutes: Il carico medio della CPU negli ultimi 5 minuti.
FifteenMinutes: Il carico medio della CPU negli ultimi 15 minuti.

Gpus

Informazioni sul server host GPUs. Questa struttura di dati include i seguenti parametri di risposta annidati:

Vendor: Il fornitore della GPU del server host.
ModelName: Il nome del modello della GPU del server host.

LoggedInUsers

Gli utenti attualmente connessi al server host. Questa struttura di dati include il seguente parametro di risposta annidato:

Username: Il nome utente dell'utente che ha effettuato l'accesso.

Tags

I tag assegnati al server. Questa struttura di dati include i seguenti parametri di risposta annidati:

Key: La chiave di tag:
Value: Il valore del tag.

Esempio

Python

Richiesta

L'esempio seguente descrive tutti i server Amazon DCV disponibili. I risultati vengono suddivisi in pagine in modo da mostrare due risultati per pagina.


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)

Risposta

Di seguito è riportato l'output di esempio.


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

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

CreateSessions

DescribeSessions