Paramètres de demande Paramètres de réponse exemple

DescribeServers

Décrit un ou plusieurs serveurs Amazon DCV.

Rubriques

Paramètres de demande
Paramètres de réponse
exemple

Paramètres de demande

ServerIds

Les IDs serveurs Amazon DCV à décrire. Si aucun n' IDs est spécifié, tous les serveurs sont renvoyés dans une sortie paginée.

Type : tableau de chaînes

Obligatoire : non

NextToken

Le jeton à utiliser pour récupérer la page de résultats suivante.

Type : chaîne

Obligatoire : non

MaxResults

Le nombre maximum de résultats à renvoyer par la demande dans une sortie paginée. Lorsque ce paramètre est utilisé, la demande renvoie uniquement le nombre de résultats spécifié sur une seule page, ainsi qu'un élément de NextToken réponse. Les résultats restants de la demande initiale peuvent être consultés en envoyant une autre demande avec la NextToken valeur renvoyée.

Plage valide : 1 - 1 000

Par défaut: 1000

Type : entier

Obligatoire : non

Paramètres de réponse

RequestId

L'identifiant unique de la demande.

Servers

Informations sur les serveurs Amazon DCV. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

Id

L'ID unique du serveur Amazon DCV.

Ip

Adresse IP du serveur Amazon DCV.

Hostname

Le nom d'hôte du serveur Amazon DCV.

Endpoints

Informations sur les points de terminaison du serveur Amazon DCV. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

IpAddress

Adresse IP du point de terminaison du serveur.

Port

Port du point de terminaison du serveur.

Protocol

Protocole utilisé par le point de terminaison du serveur. Les valeurs possibles incluent :

HTTP— Le point de terminaison utilise le protocole WebSocket (TCP).
QUIC— Le point de terminaison utilise le protocole QUIC (UDP).

WebUrlPath

Le chemin de l'URL Web du point de terminaison du serveur. Disponible uniquement pour le protocole HTTP.

Version

Version du serveur Amazon DCV.

SessionManagerAgentVersion

Version de l'agent Session Manager exécutée sur le serveur Amazon DCV.

Availability

La disponibilité du serveur Amazon DCV. Les valeurs possibles incluent :

AVAILABLE— Le serveur est disponible et prêt pour le placement des sessions.
UNAVAILABLE— Le serveur n'est pas disponible et ne peut pas accepter le placement de session.

UnavailabilityReason

La raison de l'indisponibilité du serveur Amazon DCV. Les valeurs possibles incluent :

SERVER_FULL— Le serveur Amazon DCV a atteint le nombre maximum de sessions simultanées qu'il peut exécuter.
SERVER_CLOSED— Le serveur Amazon DCV a été rendu indisponible à l'aide de l'CloseServerAPI.
UNREACHABLE_AGENT— Le Session Manager Broker ne peut pas communiquer avec l'agent Session Manager sur le serveur Amazon DCV.
UNHEALTHY_DCV_SERVER— L'agent du gestionnaire de session ne peut pas communiquer avec le serveur Amazon DCV.
EXISTING_LOGGED_IN_USER— (Serveurs Amazon DCV Windows uniquement) Un utilisateur est actuellement connecté au serveur Amazon DCV via RDP.
UNKNOWN— Le courtier du gestionnaire de session n'est pas en mesure d'en déterminer la raison.

ConsoleSessionCount

Le nombre de sessions de console sur le serveur Amazon DCV.

VirtualSessionCount

Le nombre de sessions virtuelles sur le serveur Amazon DCV.

Host

Informations sur le serveur hôte sur lequel le serveur Amazon DCV est exécuté. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

Os

Informations sur le système d'exploitation du serveur hôte. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

Family

La famille de systèmes d'exploitation. Les valeurs possibles incluent :

windows— Le serveur hôte exécute un système d'exploitation Windows.
linux— Le serveur hôte exécute un système d'exploitation Linux.

Name

Le nom du système d'exploitation.

Version

La version du système d'exploitation.

KernelVersion

(Linux uniquement) Version du noyau du système d'exploitation.

BuildNumber

(Windows uniquement) Numéro de version du système d'exploitation.

Memory

Informations sur la mémoire du serveur hôte. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

TotalBytes: Mémoire totale, en octets, sur le serveur hôte.
UsedBytes: Mémoire utilisée, en octets, sur le serveur hôte.

Swap

Informations sur le fichier d'échange du serveur hôte. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

TotalBytes: Taille totale du fichier d'échange, en octets, sur le serveur hôte.
UsedBytes: Taille du fichier d'échange utilisé, en octets, sur le serveur hôte.

Aws

Uniquement pour les serveurs Amazon DCV exécutés sur une EC2 instance Amazon. AWS-informations spécifiques. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

Region: La AWS région de l' EC2 instance Amazon.
Ec2InstanceType: Type d' EC2 instance Amazon.
Ec2InstanceId: L'ID de l' EC2 instance Amazon.
Ec2ImageId: L'ID de l' EC2 image Amazon.

CpuInfo

Informations sur le serveur hôte CPUs. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

Vendor: Le fournisseur du processeur du serveur hôte.
ModelName: Le nom du modèle du processeur du serveur hôte.
Architecture: Architecture du processeur du serveur hôte.
NumberOfCpus: Le numéro de CPUs sur le serveur hôte.
PhysicalCorePerCpu: Le nombre de cœurs de processeur par processeur.

CpuLoadAverage

Informations sur la charge du processeur du serveur hôte. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

OneMinute: Charge moyenne du processeur au cours de la dernière minute.
FiveMinutes: Charge moyenne du processeur au cours des 5 dernières minutes.
FifteenMinutes: Charge moyenne du processeur au cours des 15 dernières minutes.

Gpus

Informations sur le serveur hôte GPUs. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

Vendor: Le fournisseur du GPU du serveur hôte.
ModelName: Le nom du modèle du GPU du serveur hôte.

LoggedInUsers

Les utilisateurs actuellement connectés au serveur hôte. Cette structure de données inclut le paramètre de réponse imbriqué suivant :

Username: Le nom d'utilisateur de l'utilisateur connecté.

Tags

Les balises attribuées au serveur. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

Key: Identification de balise.
Value: Valeur de balise.

exemple

Python

Demande

L'exemple suivant décrit tous les serveurs Amazon DCV disponibles. Les résultats sont paginés pour afficher deux résultats par page.


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)

Réponse

Voici un exemple de sortie.


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

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

CreateSessions

DescribeSessions