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

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

DescribeSessions

描述一个或多个 NICE DCV 会话。

请求参数

SessionIds

要描述的会话的 ID。

类型: 字符串

:必需 否

NextToken

用于检索下一页结果的令牌。

类型: 字符串

:必需 否

Filters

要应用于请求的其他过滤器。支持的筛选条件包括:

  • 标签:key-分配给会话的标签。

  • 所有者-会话所有者。

类型: 字符串

:必需 否

响应参数

Id

会话的唯一 ID。

Name

会话的名称。

Owner

会话的所有者。

Server

有关运行会话的服务器的信息。此数据结构包括以下嵌套响应参数:

  • Ip

    NICE DCV 服务器主机的 IP 地址。

  • Hostname

    NICE DCV 服务器主机的主机名。

  • Port

    NICE DCV 服务器与 NICE DCV 客户端通信的端口。

  • Tags

    分配给会话的标签。此数据结构包括以下嵌套响应参数:

    • Key

      标签键。

    • Value

      标签值。

Type

会话的类型。

State

会话的当前状态。可能的值有:

  • CREATING-经纪商正在创建会话。

  • READY-会话已准备好接受客户端连接。

  • DELETING-正在删除会话。

  • DELETED-会话已删除。

  • UNKNOWN-无法确定会话的状态。代理和代理可能无法通信。

CreationTime

创建会话的日期和时间。

LastDisconnectionTime

上次断开客户端连接的日期和时间。

NumOfConnections

活动的客户端连接数。

StorageRoot

指定用于会话存储的文件夹的路径。有关 NICE DCV 会话存储的更多信息,请参阅启用会话存储中的NICE DCV 管理员指南

类型: 字符串

:必需 否

Example

Python

Request

下面示例说明了由user1并且有一个os=windows

from swagger_client.models.describe_sessions_request_data import DescribeSessionsRequestData from swagger_client.models.key_value_pair import KeyValuePair 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 describe_sessions(session_ids=None, next_token=None, tags=None, owner=None): filters = list() if tags: for tag in tags: filter_key_value_pair = KeyValuePair(key='tag:' + tag['Key'], value=tag['Value']) filters.append(filter_key_value_pair) if owner: filter_key_value_pair = KeyValuePair(key='owner', value=owner) filters.append(filter_key_value_pair) request = DescribeSessionsRequestData(session_ids=session_ids, filters=filters, next_token=next_token) print('Describe Sessions Request:', request) api_instance = get_sessions_api() api_response = api_instance.describe_sessions(body=request) print('Describe Sessions Response', api_response) def main(): describe_sessions( owner='user1', tags=[{'Key': 'os', 'Value': 'windows'}])

Response

下面是示例输出。

{ "Sessions": [ { "Id": "SessionId1897", "Name": "a session name", "Owner": "an owner 1890", "Server": { "Ip": "1.1.1.123", "Hostname": "server hostname", "Port": "1222", "Tags": [ { "Key": "os", "Value": "windows" }, { "Key": "ram", "Value": "4gb" } ] }, "Type": "VIRTUAL", "State": "READY", "CreationTime": "2020-10-06T10:15:31.633Z", "LastDisconnectionTime": "2020-10-06T10:15:31.633Z", "NumOfConnections": 2, "StorageRoot" : "/storage/root" }, { "Id": "SessionId1895", "Name": "a session name", "Owner": "an owner 1890", "Server": { "Ip": "1.1.1.123", "Hostname": "server hostname", "Port": "1222", "Tags": [ { "Key": "os", "Value": "windows" }, { "Key": "ram", "Value": "4gb" } ] }, "Type": "VIRTUAL", "State": "DELETING", "CreationTime": "2020-10-06T10:15:31.633Z", "LastDisconnectionTime": "2020-10-06T10:15:31.633Z", "NumOfConnections": 2, "StorageRoot" : "/storage/root" } ] }