CloseServers - Gestore di sessioni Amazon DCV
Parametri della richiestaParametri di rispostaEsempio

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

CloseServers

Chiude uno o più server Amazon DCV. Quando chiudi un server Amazon DCV, lo rendi non disponibile per il posizionamento della sessione Amazon DCV. Non puoi creare sessioni Amazon DCV su server chiusi. La chiusura di un server garantisce che non vi siano sessioni in esecuzione e che gli utenti non possano creare nuove sessioni su di esso.

Parametri della richiesta

ServerId

L'ID del server da chiudere.

Tipo: stringa

Campo obbligatorio: sì

Force

Forza l'operazione di chiusura. Se si specificatrue, il server viene chiuso anche se ha sessioni in esecuzione. Le sessioni continuano a funzionare.

Tipo: Booleano

Campo obbligatorio: no

Parametri di risposta

RequestId

L'ID univoco della richiesta.

SuccessfulList

Informazioni sui server Amazon DCV che sono stati chiusi con successo. Questa struttura di dati include il seguente parametro di risposta annidato:

ServerId

L'ID del server che è stato chiuso con successo.

UnsuccessfulList

Informazioni sui server Amazon DCV che non è stato possibile chiudere. Questa struttura di dati include i seguenti parametri di risposta annidati:

CloseServerRequestData

Informazioni sulla richiesta originale non riuscita. Questa struttura di dati include il seguente parametro di risposta annidato:

ServerId

L'ID del server Amazon DCV che non è stato possibile chiudere.

Force

Il parametro di forza richiesto.

FailureCode

Il codice dell'errore.

FailureReason

Il motivo dell'errore.

Esempio

Python
Richiesta

L'esempio seguente chiude due server Amazon DCV (serverId1eserverId2). serverId2Il server non esiste e causa un errore.

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

Di seguito è riportato l'output di esempio.

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