CloseServers

하나 이상의 Amazon DCV 서버를 종료합니다. Amazon DCV 서버를 종료하면 Amazon DCV 세션 배치에 해당 서버를 사용할 수 없게 됩니다. 종료된 서버에서는 Amazon DCV 세션을 생성할 수 없습니다. 서버를 종료하면 해당 서버에서 어떠한 세션도 실행되지 않고 사용자가 새 세션을 만들 수 없게 됩니다.

요청 파라미터

ServerId

종료할 서버의 ID입니다.

유형: 문자열

필수 항목 여부: 예

Force

종료 작업을 강제로 실행합니다. true 값을 지정하면 실행 중인 세션이 있더라도 서버가 종료됩니다. 세션은 계속 실행됩니다.

유형: 부울

필수 여부: 아니요

응답 파라미터

RequestId

요청의 고유 ID입니다.

SuccessfulList

성공적으로 종료된 Amazon DCV 서버에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.

ServerId

성공적으로 종료된 서버의 ID입니다.

UnsuccessfulList

종료할 수 없는 Amazon DCV 서버에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.

CloseServerRequestData

실패한 원래 요청에 대한 정보입니다. 이 데이터 구조에는 다음과 같은 중첩된 응답 파라미터가 포함됩니다.

ServerId

종료할 수 없는 Amazon DCV 서버의 ID입니다.

Force

요청된 강제 파라미터입니다.

FailureCode

실패 코드입니다.

FailureReason

실패 이유

예시

Python

요청

다음 예제에서는 두 개의 Amazon DCV 서버(serverId1 및 serverId2)를 종료합니다. serverId2 서버가 존재하지 않아 오류가 발생합니다.

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

응답

다음은 출력 샘플입니다.

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