查询某集群的会话连接信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeClusterConnections

系统规定参数。取值:DescribeClusterConnections。

ClusterId String gws-xxx

云桌面集群 id。

EndTime String 2020-09-01

查询区间的截止日期。

StartTime String 2020-09-07

查询区间的起始日期。

TaskId String t-xxx

做异步查询时的 task id。

返回数据

名称 类型 示例值 描述
Connections Array of Connection

描述连接会话信息的数组。

ClientName String client-xxx

客户端的主机名称.

HostName String hostname

主机名称。

InstanceId String i-xxx

实例 id。

InstanceName String test

实例名称。

LogoffStatus String 0
  • 0:此会话已正常退出
  • 空值:此会话还未退出
LogoffTime String 2020-09-03T01:02:03.456Z

此会话的退出时间。

当此值为空时,说明此会话还未退出。

LogonTime String 2020-09-01T01:02:03.456Z

此会话的登入时间。

RequestId String XXX-XXX

请求 id。

TaskFinished Boolean true
  • true:当前 task 已经完成
  • false:当前 task 还在运行中
TaskId String t-xxx
  • 调用时如果入参TaskId为空,则调用方需使用返回值中的TaskId,继续调用此API来获得查询命令的结果。
  • 调用时如果入参TaskId非空,则返回值会查询此TaskId 的运行状态。
TotalCount Long 1

数组Connections的长度。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeClusterConnections
&ClusterId=gws-xxx
&EndTime=2020-09-01
&StartTime=2020-09-07
&<公共请求参数>

正常返回示例

XML格式

<Connections>
    <LogoffStatus>0</LogoffStatus>
    <LogoffTime>2020-09-03T01:02:03.456Z</LogoffTime>
    <ClientName>client-xxx</ClientName>
    <LogonTime>2020-09-01T01:02:03.456Z</LogonTime>
    <InstanceId>i-xxx</InstanceId>
</Connections>
<TotalCount>1</TotalCount>
<TaskId>t-xxx</TaskId>
<RequestId>XXX-XXX</RequestId>
<TaskFinished>true</TaskFinished>

JSON格式

{
    "Connections": {
        "LogoffStatus": 0,
        "LogoffTime": "2020-09-03T01:02:03.456Z",
        "ClientName": "client-xxx",
        "LogonTime": "2020-09-01T01:02:03.456Z",
        "InstanceId": "i-xxx"
    },
    "TotalCount": 1,
    "TaskId": "t-xxx",
    "RequestId": "XXX-XXX",
    "TaskFinished": true
}