CloseServers

Schließt einen oder mehrere Amazon DCV-Server. Wenn Sie einen Amazon DCV-Server schließen, machen Sie ihn für die Platzierung von Amazon DCV-Sitzungen nicht verfügbar. Sie können keine Amazon DCV-Sitzungen auf geschlossenen Servern erstellen. Durch das Schließen eines Servers wird sichergestellt, dass keine Sitzungen auf dem Server laufen und dass Benutzer keine neuen Sitzungen auf dem Server erstellen können.

Anforderungsparameter

ServerId

Die ID des Servers, der geschlossen werden soll.

Typ: Zeichenfolge

Erforderlich: Ja

Force

Erzwingt den Schließvorgang. Wenn Sie dies angebentrue, wird der Server geschlossen, auch wenn er laufende Sitzungen hat. Die Sitzungen werden weiterhin ausgeführt.

Typ: Boolesch

Erforderlich: Nein

Antwortparameter

RequestId

Die eindeutige ID der Anfrage.

SuccessfulList

Informationen über die Amazon DCV-Server, die erfolgreich geschlossen wurden. Diese Datenstruktur umfasst den folgenden verschachtelten Antwortparameter:

ServerId

Die ID des Servers, der erfolgreich geschlossen wurde.

UnsuccessfulList

Informationen zu den Amazon DCV-Servern, die nicht geschlossen werden konnten. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:

CloseServerRequestData

Informationen über die ursprüngliche Anfrage, die fehlgeschlagen ist. Diese Datenstruktur umfasst den folgenden verschachtelten Antwortparameter:

ServerId

Die ID des Amazon DCV-Servers, der nicht geschlossen werden konnte.

Force

Der angeforderte Force-Parameter.

FailureCode

Der Code des Fehlers.

FailureReason

Der Grund für den Fehlschlag.

Beispiel

Python

Anforderung

Das folgende Beispiel schließt zwei Amazon DCV-Server (serverId1undserverId2). Der Server serverId2 ist nicht vorhanden und führt zu einem Ausfall.

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"])

Antwort

Im Folgenden finden Sie ein Beispiel für die Ausgabe.

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