DeleteSessions

지정된 NICE DCV 세션을 삭제하고 브로커의 캐시에서 해당 세션을 제거합니다.

요청 파라미터

SessionId

삭제할 세션의 ID입니다.

유형: 문자열

필수 항목 여부: 예

Owner

삭제할 세션의 소유자입니다.

유형: 문자열

필수 항목 여부: 예

Force

NICE DCV 서버에서 삭제를 시도하여 브로커 캐시에서 세션을 제거합니다. 이는 브로커 캐시에서 오래된 세션을 제거하는 데 유용합니다. 예를 들어 NICE DCV 서버가 중지되었지만 세션이 여전히 브로커에 등록되어 있는 경우, 이 플래그를 사용하여 브로커 캐시에서 세션을 제거하세요.

세션이 여전히 활성 상태인 경우 브로커가 다시 캐싱한다는 점에 유의하세요.

유효한 값: true | false

유형: 부울

필수 항목 여부: 아니요

응답 파라미터

SessionId

세션 ID

State

세션이 성공적으로 삭제된 경우에만 반환됩니다. 세션의 현재 상태를 나타냅니다. 요청이 성공적으로 완료되면 세션이 DELETING 상태로 전환됩니다. 세션이 삭제되는 데 몇 분 정도 걸릴 수 있습니다. 세션이 삭제되면 상태가 DELETING에서 DELETED로 전환됩니다.

FailureReason

일부 세션을 삭제할 수 없는 경우에만 반환됩니다. 세션을 삭제할 수 없는 이유를 나타냅니다.

예

Python

요청

다음 예제에서는 두 개의 세션, 즉 user1이 소유한 SessionId123 ID의 세션과 user99가 소유한 SessionIdabc ID의 세션을 삭제합니다.

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

응답

다음은 출력 샘플입니다. SessionId123은 성공적으로 삭제되었지만 SessionIdabc는 삭제할 수 없습니다.

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