CloseServers

Cierra uno o más servidores Amazon DCV. Cuando cierra un servidor Amazon DCV, deja de estar disponible para la ubicación de sesiones de Amazon DCV. No puede crear sesiones de Amazon DCV en servidores cerrados. Al cerrar un servidor se garantiza que no hay sesiones ejecutándose en él y que los usuarios no pueden crear nuevas sesiones en él.

Parámetros de solicitud

ServerId

ID del túnel que se va a cerrar.

Tipo: cadena

Obligatorio: sí

Force

Fuerza la operación de cierre. Si especifica true, el servidor se cerrará aunque tenga sesiones en ejecución. Las sesiones siguen ejecutándose.

Tipo: Booleano

Obligatorio: no

Parámetros de respuesta

RequestId

ID único de la solicitud.

SuccessfulList

Información sobre los servidores Amazon DCV que se cerraron correctamente. Esta estructura de datos incluye el siguiente parámetro de respuesta anidado:

ServerId

ID del servidor que se cerró correctamente.

UnsuccessfulList

Información sobre los servidores Amazon DCV que no se han podido cerrar. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:

CloseServerRequestData

Información sobre la solicitud original que falló. Esta estructura de datos incluye el siguiente parámetro de respuesta anidado:

ServerId

ID del servidor Amazon DCV que no se ha podido cerrar.

Force

Parámetro forzar solicitado.

FailureCode

Código del error.

FailureReason

El motivo del error.

Ejemplo

Python

Solicitud

El siguiente ejemplo cierra dos servidores Amazon DCV (serverId1 y serverId2). El servidor serverId2 no existe y se produce un error.

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

Respuesta

A continuación se muestra la salida de ejemplo.

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