CloseServers - Amazon DCV Session Manager

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

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

请求的 force 参数。

FailureCode

失败代码。

FailureReason

失败的原因。

示例

Python
请求

以下示例关闭两个 Amazon 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"])
响应

以下是示例输出。

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