CloseServers

Ferme un ou plusieurs serveurs Amazon DCV. Lorsque vous fermez un serveur Amazon DCV, vous le rendez indisponible pour le placement de sessions Amazon DCV. Vous ne pouvez pas créer de sessions Amazon DCV sur des serveurs fermés. La fermeture d'un serveur garantit qu'aucune session n'est en cours d'exécution sur celui-ci et que les utilisateurs ne peuvent pas y créer de nouvelles sessions.

Paramètres de demande

ServerId

ID du serveur à fermer.

Type : String

Obligatoire : oui

Force

Force l'opération rapprochée. Si vous le spécifieztrue, le serveur est fermé même s'il a des sessions en cours d'exécution. Les sessions continuent de se dérouler.

Type : booléen

Obligatoire : non

Paramètres de réponse

RequestId

L'identifiant unique de la demande.

SuccessfulList

Informations sur les serveurs Amazon DCV qui ont été fermés avec succès. Cette structure de données inclut le paramètre de réponse imbriqué suivant :

ServerId

ID du serveur qui a été fermé avec succès.

UnsuccessfulList

Informations sur les serveurs Amazon DCV qui n'ont pas pu être fermés. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

CloseServerRequestData

Informations relatives à la demande initiale qui a échoué. Cette structure de données inclut le paramètre de réponse imbriqué suivant :

ServerId

L'ID du serveur Amazon DCV qui n'a pas pu être fermé.

Force

Le paramètre de force demandé.

FailureCode

Le code de l'échec.

FailureReason

Raison de l'échec.

exemple

Python

Demande

L'exemple suivant ferme deux serveurs Amazon DCV (serverId1etserverId2). Le serveur serverId2 n'existe pas et entraîne une panne.

from swagger_client.models import CloseServerRequestData

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 close_servers(server_ids):
    request = [CloseServerRequestData(server_id=server_id) for server_id in server_ids]
    print('Close Servers Request:', request)
    api_instance = get_servers_api()
    api_response = api_instance.close_servers(body=request)
    print('Close Servers Response:', api_response)
    open_servers(server_ids)

def main():
    close_servers(["serverId1", "serverId2"])

Réponse

Voici un exemple de sortie.

{
    "RequestId": "4d7839b2-a03c-4b34-a40d-06c8b21099e6",
    "SuccessfulList": [
        {
            "ServerId": "serverId1"
        }
    ],
    "UnsuccessfulList": [
        {
            "OpenServerRequestData": {
                "ServerId": "serverId2"
            },
            "FailureCode": "DCV_SERVER_NOT_FOUND",
            "FailureReason": "Dcv server not found."
        }
    ]
}