CloseServers

Fecha um ou mais servidores Amazon DCV. Ao fechar um servidor Amazon DCV, você o torna indisponível para colocação de sessões do Amazon DCV. Você não pode criar sessões do Amazon DCV em servidores fechados. Fechar um servidor garante que nenhuma sessão seja executada nele e que os usuários não podem criar sessões nele.

Parâmetros de solicitação

ServerId

O ID do servidor a ser fechado.

Tipo: string

Obrigatório: Sim

Force

Força a operação de fechamento. Se você especificar true, o servidor será fechado mesmo que tenha sessões em execução. As sessões continuam sendo executadas.

Tipo: booliano

Obrigatório: Não

Parâmetros de resposta

RequestId

O ID exclusivo da solicitação.

SuccessfulList

Informações sobre os servidores Amazon DCV que foram fechados com sucesso. Essa estrutura de dados inclui o seguinte parâmetro de resposta aninhada:

ServerId

O ID do servidor que foi fechado com sucesso.

UnsuccessfulList

Informações sobre os servidores Amazon DCV que não puderam ser fechados. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

CloseServerRequestData

Informações sobre a solicitação original com falha. Essa estrutura de dados inclui o seguinte parâmetro de resposta aninhada:

ServerId

O ID do servidor Amazon DCV que não pôde ser fechado.

Force

O parâmetro de força solicitado.

FailureCode

O código da falha.

FailureReason

O motivo da falha.

Exemplo

Python

Solicitação

O exemplo a seguir fecha dois servidores Amazon DCV (serverId1 and serverId2). O servidor serverId2 não existe e resulta em uma falha.

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

Resposta

Esta é uma saída de exemplo.

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