DeleteSessions - NICE DCV Session Manager
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DeleteSessions

删除指定的 NICE DCV 会话,并将其从 Broker 的缓存中删除。

请求参数

SessionId

要删除的会话的 ID。

类型:字符串

必需:是

Owner

要删除的会话的所有者。

类型:字符串

必需:是

Force

从 Broker 的缓存中删除会话,并尝试从 NICE DCV 服务器中删除会话。这对于从 Broker 缓存中删除过时的会话非常有用。例如,如果 NICE DCV 服务器已停止,但仍在 Broker 上注册会话,请使用该标记从 Broker 的缓存中清除会话。

请记住,如果会话仍处于活动状态,Broker 将重新缓存会话。

有效值:true | false

类型:布尔值

必需:否

响应参数

SessionId

会话 ID

State

仅在成功删除会话时返回。指示会话的当前状态。如果请求成功完成,会话将转变为 DELETING 状态。删除会话可能需要几分钟的时间。在已删除会话后,状态将从 DELETING 转变为 DELETED

FailureReason

仅在无法删除某些会话时返回。指示无法删除会话的原因。

示例

Python
请求

以下示例删除两个会话 - 一个会话由 user1 拥有并具有 ID SessionId123,另一个会话由 user99 拥有并具有 ID SessionIdabc

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