DescribeServers - Amazon DCV-Sitzungsmanager
AnforderungsparameterAntwortparameterBeispiel

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribeServers

Beschreibt einen oder mehrere Amazon DCV-Server.

Anforderungsparameter

ServerIds

Der IDs zu beschreibende Amazon DCV-Server. Wenn keine angegeben IDs sind, werden alle Server in einer paginierten Ausgabe zurückgegeben.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

NextToken

Das Token, das zum Abrufen der nächsten Ergebnisseite verwendet werden soll.

Typ: Zeichenfolge

Erforderlich: Nein

MaxResults

Die maximale Anzahl von Ergebnissen, die von der Anforderung in einer paginierten Ausgabe zurückgegeben werden sollen. Wenn dieser Parameter verwendet wird, gibt die Anforderung nur die angegebene Anzahl von Ergebnissen auf einer einzelnen Seite zusammen mit einem NextToken Antwortelement zurück. Die verbleibenden Ergebnisse der ersten Anfrage können angezeigt werden, indem eine weitere Anfrage mit dem zurückgegebenen NextToken Wert gesendet wird.

Gültiger Bereich: 1–1 000

Standard: 1000

Typ: Ganzzahl

Erforderlich: Nein

Antwortparameter

RequestId

Die eindeutige ID der Anfrage.

Servers

Informationen zu den Amazon DCV-Servern. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

Id

Die eindeutige ID des Amazon DCV-Servers.

Ip

Die IP-Adresse des Amazon DCV-Servers.

Hostname

Der Hostname des Amazon DCV-Servers.

Endpoints

Informationen zu den Amazon DCV-Serverendpunkten. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

IpAddress

Die IP-Adresse des Serverendpunkts.

Port

Der Port des Serverendpunkts.

Protocol

Das vom Serverendpunkt verwendete Protokoll. Mögliche Werte sind:

  • HTTP— Der Endpunkt verwendet das WebSocket (TCP-) Protokoll.

  • QUIC— Der Endpunkt verwendet das QUIC-Protokoll (UDP).

WebUrlPath

Der Web-URL-Pfad des Serverendpunkts. Nur für das HTTP-Protokoll verfügbar.

Version

Die Version des Amazon DCV-Servers.

SessionManagerAgentVersion

Die Version von Session Manager Agent, die auf dem Amazon DCV-Server ausgeführt wird.

Availability

Die Verfügbarkeit des Amazon DCV-Servers. Mögliche Werte sind:

  • AVAILABLE— Der Server ist verfügbar und bereit für die Sitzungsplatzierung.

  • UNAVAILABLE— Der Server ist nicht verfügbar und kann die Sitzungsplatzierung nicht akzeptieren.

UnavailabilityReason

Der Grund für die Nichtverfügbarkeit des Amazon DCV-Servers. Mögliche Werte sind:

  • SERVER_FULL— Der Amazon DCV-Server hat die maximale Anzahl gleichzeitiger Sitzungen erreicht, die er ausführen kann.

  • SERVER_CLOSED— Der Amazon DCV-Server wurde mithilfe der CloseServerAPI nicht verfügbar gemacht.

  • UNREACHABLE_AGENT— Der Session Manager Broker kann nicht mit dem Session Manager Agent auf dem Amazon DCV-Server kommunizieren.

  • UNHEALTHY_DCV_SERVER— Der Session Manager Agent kann nicht mit dem Amazon DCV-Server kommunizieren.

  • EXISTING_LOGGED_IN_USER— (Nur Windows Amazon DCV-Server) Ein Benutzer ist derzeit über RDP am Amazon DCV-Server angemeldet.

  • UNKNOWN— Der Session Manager Broker kann den Grund nicht ermitteln.

ConsoleSessionCount

Die Anzahl der Konsolensitzungen auf dem Amazon DCV-Server.

VirtualSessionCount

Die Anzahl der virtuellen Sitzungen auf dem Amazon DCV-Server.

Host

Informationen über den Host-Server, auf dem der Amazon DCV-Server läuft. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

Os

Informationen zum Betriebssystem des Hostservers. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

Family

Die Betriebssystemfamilie. Mögliche Werte sind:

  • windows— Auf dem Host-Server wird ein Windows-Betriebssystem ausgeführt.

  • linux— Auf dem Host-Server wird ein Linux-Betriebssystem ausgeführt.

Name

Der Name des Betriebssystems.

Version

Die Version des Betriebssystems.

KernelVersion

(Nur Linux) Die Kernelversion des Betriebssystems.

BuildNumber

(Nur Windows) Die Buildnummer des Betriebssystems.

Memory

Informationen über den Arbeitsspeicher des Hostservers. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

TotalBytes

Der Gesamtspeicher auf dem Hostserver in Byte.

UsedBytes

Der verwendete Speicher auf dem Hostserver in Byte.

Swap

Informationen über die Swap-Datei des Hostservers. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

TotalBytes

Die Gesamtgröße der Swap-Datei auf dem Hostserver in Byte.

UsedBytes

Die verwendete Größe der Swap-Datei in Byte auf dem Hostserver.

Aws

Nur für Amazon DCV-Server, die auf einer EC2 Amazon-Instance laufen. AWS-spezifische Informationen. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

Region

Die AWS Region der EC2 Amazon-Instance.

Ec2InstanceType

Der Typ der EC2 Amazon-Instance.

Ec2InstanceId

Die ID der EC2 Amazon-Instance.

Ec2ImageId

Die ID des EC2 Amazon-Bildes.

CpuInfo

Informationen über die des Hostservers CPUs. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

Vendor

Der Hersteller der CPU des Hostservers.

ModelName

Der Modellname der CPU des Hostservers.

Architecture

Die Architektur der CPU des Hostservers.

NumberOfCpus

Die Nummer von CPUs auf dem Hostserver.

PhysicalCorePerCpu

Die Anzahl der CPU-Kerne pro CPU.

CpuLoadAverage

Informationen zur CPU-Last des Hostservers. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

OneMinute

Die durchschnittliche CPU-Auslastung im letzten Zeitraum von 1 Minute.

FiveMinutes

Die durchschnittliche CPU-Last in den letzten 5 Minuten.

FifteenMinutes

Die durchschnittliche CPU-Last in den letzten 15 Minuten.

Gpus

Informationen über die des Hostservers GPUs. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

Vendor

Der Anbieter der GPU des Hostservers.

ModelName

Der Modellname der GPU des Hostservers.

LoggedInUsers

Die Benutzer, die derzeit am Hostserver angemeldet sind. Diese Datenstruktur umfasst den folgenden verschachtelten Antwortparameter:

Username

Der Benutzername des angemeldeten Benutzers.

Tags

Die dem Server zugewiesenen Tags. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

Key

Der Tag-Schlüssel.

Value

Der Tag-Wert.

Beispiel

Python
Anforderung

Das folgende Beispiel beschreibt alle verfügbaren Amazon DCV-Server. Die Ergebnisse sind paginiert, sodass zwei Ergebnisse pro Seite angezeigt werden.

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)
Antwort

Das Folgende ist die Beispielausgabe.

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