CloseServers - NICE DCV 会话管理器
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

CloseServers

关闭一个或多个 NICE DCV 服务器。关闭 NICE DCV 服务器时,将使其不可用于 NICE DCV 会话放置。您无法创建 NICE DCV 会话Closed服务器。关闭服务器可确保其上没有运行任何会话,并且用户无法在其上创建新会话。

请求参数

ServerId

要关闭的服务器的 ID。

类型: 字符串

:必需 是

Force

强制关闭操作。如果您指定true,即使服务器有正在运行的会话,服务器也会关闭。会话将继续运行。

类型: Boolean

:必需 否

响应参数

RequestId

请求的唯一 ID。

SuccessfulList

有关已成功关闭的 NICE DCV 服务器的信息。此数据结构包括以下嵌套响应参数:

ServerId

已成功关闭的服务器的 ID。

UnsuccessfulList

有关无法关闭的 NICE DCV 服务器的信息。此数据结构包括以下嵌套响应参数:

CloseServerRequestData

有关失败的原始请求的信息。此数据结构包括以下嵌套响应参数:

ServerId

无法关闭的 NICE DCV 服务器的 ID。

Force

请求的力参数。

FailureCode

失败的代码。

FailureReason

失败的原因。

Example

Python

Request

以下示例关闭两个 NICE DCV 服务器(serverId1serverId2)。服务器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"])

Response

下面是示例输出。

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