本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
GetSessionConnectionData
获取特定用户到特定 NICE DCV 会话的连接的连接信息。
请求参数
SessionId-
要查看连接信息的会话的 ID。
类型：字符串
必需：是
User-
要查看连接信息的用户的名称。
类型：字符串
必需：是
响应参数
Id-
会话的唯一 ID。
Name-
会话的名称。
Owner-
会话的所有者。
Server-
有关运行会话的服务器的信息。该数据结构包括以下嵌套的响应参数：
Ip-
NICE DCV 服务器主机的 IP 地址。
Hostname-
NICE DCV 服务器主机的主机名。
Port-
NICE DCV 服务器与 NICE DCV 客户端通信时使用的端口。
Endpoints-
有关 NICE DCV 服务器终端节点的信息。该数据结构包括以下嵌套的响应参数：
IpAddress-
服务器终端节点的 IP 地址。
Port-
服务器终端节点的端口。
Protocol-
服务器终端节点使用的协议。可能的值包括：
-
HTTP- 终端节点使用 WebSocket (TCP) 协议。 -
QUIC- 终端节点使用 QUIC (UDP) 协议。
-
WebUrlPath-
服务器终端节点的 Web URL 路径。仅适用于 HTTP 协议。
WebUrlPath-
NICE DCV 服务器配置文件的路径。
Tags-
分配给服务器的标签。该数据结构包括以下嵌套的响应参数：
Key-
标签键。
Value-
标签值。
Type-
会话的类型。
State-
会话的当前状态。可能的值有：
-
CREATING- Broker 正在创建会话。 -
READY- 会话准备好接受客户端连接。 -
DELETING- 正在删除会话。 -
DELETED- 已删除会话。 -
UNKNOWN- 无法确定会话的状态。Broker 和 Agent 可能无法通信。
-
CreationTime-
创建会话的日期和时间。
LastDisconnectionTime-
上次客户端断开连接的日期和时间。
NumOfConnections-
用户到会话的并发连接数。
ConnectionToken-
用于连接到会话的身份验证令牌。
其他信息
可以将从该 API 中获取的信息传送到 NICE DCV 客户端，以便连接到 NICE DCV 会话。
对于 NICE DCV Web 客户端，您可以构建一个可在浏览器中打开的 URL。该 URL 采用以下格式：
https://{Ip}:{Port}{WebUrlPath}?authToken={ConnectionToken}#{SessionId}.
对于 NICE DCV 本机客户端，您可以使用 dcv:// 模式构建一个 URL。在安装 NICE DCV 本机客户端后，它在系统中将自身注册为 dcv:// URL 的处理程序。该 URL 采用以下格式：
dcv://{Ip}:{Port}{WebUrlPath}?authToken={ConnectionToken}#{SessionId}.
注意
如果您使用 Amazon EC2，则 IP 地址应该是公有地址。如果您的配置在网关后面具有 NICE DCV 主机，请指定网关地址，而不是 SessionConnectionData API 返回的地址。