本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeSessions
描述一个或多个 NICE DCV 会话。
请求参数
SessionIds
-
要描述的会话的 ID。
类型: 字符串
:必需 否
NextToken
-
用于检索下一页结果的令牌。
类型: 字符串
:必需 否
Filters
-
要应用于请求的其他筛选器。支持的筛选器包括:
-
标签-分配给会话的标签。
-
所有者-会话所有者。
类型: 字符串
:必需 否
-
响应参数
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 管理员指南.
类型: 字符串
:必需 否