CloseServers - Amazon DCV セッションマネージャー

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CloseServers

1 つまたは複数の 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
リクエスト

次の例では、2 つの 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." } ] }