DeleteSessions - 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à.

DeleteSessions

Elimina la sessione Amazon DCV specificata e la rimuove dalla cache del Broker.

Parametri della richiesta

SessionId

L'ID della sessione da eliminare.

Tipo: stringa

Campo obbligatorio: sì

Owner

Il proprietario della sessione da eliminare.

Tipo: stringa

Campo obbligatorio: sì

Force

Rimuove una sessione dalla cache del Broker tentando di eliminarla dal server Amazon DCV. Ciò è utile per rimuovere le sessioni obsolete dalla cache del Broker. Ad esempio, se un server Amazon DCV è stato interrotto, ma le sessioni sono ancora registrate sul Broker, utilizza questo flag per eliminare le sessioni dalla cache del Broker.

Tieni presente che se la sessione è ancora attiva, viene nuovamente memorizzata nella cache dal Broker.

Valori validi: true | false

Tipo: Booleano

Campo obbligatorio: no

Parametri di risposta

SessionId

L'ID della sessione

State

Restituito solo se le sessioni sono state eliminate con successo. Indica lo stato corrente della sessione. Se la richiesta viene completata correttamente, la sessione passa allo DELETING stato. L'eliminazione della sessione potrebbe richiedere alcuni minuti. Una volta eliminata, lo stato passa da DELETING aDELETED.

FailureReason

Restituito solo se alcune sessioni non possono essere eliminate. Indica il motivo per cui la sessione non può essere eliminata.

Esempio

Python
Richiesta

L'esempio seguente elimina due sessioni: una sessione con un ID di SessionId123 proprietà di user1 e una sessione con un ID di proprietà SessionIdabc di. user99

from swagger_client.models.delete_session_request_data import DeleteSessionRequestData

def get_sessions_api():
    api_instance = swagger_client.SessionsApi(swagger_client.ApiClient(get_client_configuration()))
    set_request_headers(api_instance.api_client)
    return api_instance

def delete_sessions(sessions_to_delete, force=False):
    delete_sessions_request = list()
    for session_id, owner in sessions_to_delete:
        a_request = DeleteSessionRequestData(session_id=session_id, owner=owner, force=force)
        delete_sessions_request.append(a_request)

    print('Delete Sessions Request:', delete_sessions_request)
    api_instance = get_sessions_api()
    api_response = api_instance.delete_sessions(body=delete_sessions_request)
    print('Delete Sessions Response', api_response)

def main():
    delete_sessions([('SessionId123', 'an owner user1'), ('SessionIdabc', 'user99')])
Risposta

Di seguito è riportato l'output di esempio. SessionId123è stato eliminato con successo, mentre non è SessionIdabc stato possibile eliminarlo.

{
    "RequestId": "10311636-df90-4cd1-bcf7-474e9675b7cd",
    "SuccessfulList": [
        {
            "SessionId": "SessionId123",
            "State": "DELETING"
        }
    ],
    "UnsuccessfulList": [
        {
            "SessionId": "SessionIdabc",
            "FailureReason": "The requested dcvSession does not exist"
        }
    ]
}