使用DescribeDesktopGroupSessions API查询共享型云电脑会话监控详情-无影云电脑企业版-阿里云-阿里云帮助中心

查询共享型云电脑会话监控详情。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecd:DescribeDesktopGroupSessions	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
SessionStatus	string	否	连接状态。枚举值： Connected：连接。 Disconnected：断开。	Connected
OwnType	integer	否	会话类型。枚举值： 0：单会话。 1：多会话。	1
EndUserId	string	否	连接会话的终端用户 ID。	alice
StartTime	string	否	查询开始时间。	"2022-08-31T06:56:45Z"
EndTime	string	否	查询结束时间。	"2022-08-31T06:56:45Z"
MaxResults	integer	否	每页最大数量。	20
NextToken	string	否	下一页 Token。	AAAAAV3MpHK1AP0pfERHZN5pu6ljnKKgSRjo8yXAIT5QSvkU
FillTerminalInfo	boolean	否	是否补充终端信息。
Language	string	否	返回信息语言类型。	zh-CN
DesktopGroupIds	array	否	共享桌面组 ID 列表。
	string	否	共享桌面组 ID。	dg-4oyi32wmrctgx****
DesktopGroupName	string	否	共享桌面名称。	ecd-4oyi32wmrctgx****

返回参数

名称	类型	描述	示例值
	object	返回对象。
RequestId	string	请求 ID。	D0920845-7359-59FC-9899-B****
TotalCount	integer	总数。	15
Sessions	array<object>	会话数据列表。
Session	object	会话详情。
EndUserId	string	连接会话的终端用户 ID。	alice
DesktopGroupId	string	共享型云电脑 ID。	dg-iaqu3bi2xtie****
DesktopGroupName	string	共享型云电脑名称。	DemoCCGroup
OfficeSiteId	string	办公网络 ID。	cn-hangzhou+dir-8904****
OfficeSiteName	string	办公网络名称。	DemoOfficeNetwork
OwnType	integer	会话类型。枚举值： 0：单会话。 1：多会话。	0
SessionStatus	string	会话连接状态。枚举值： Connected：连接。 Disconnected：断开。	Connected
DesktopId	string	若会话状态为连接，则表示当前连接的云电脑 ID；若会话状态为断开，则表示最近一次连接的云电脑 ID。	ecd-g6t1ukbaea****
ClientOS	string	客户端的操作系统。	windows
ClientVersion	string	客户端版本。	7.8.0
ClientIp	string	客户端 IP。	172.21.XX.XX
LatestConnectionTime	long	最近一次连接时长。单位：秒。	120
TotalConnectionDuration	long	连接总时长。单位：秒。	120
SessionIdleTime	long	云电脑空闲时长。单位：秒。	120
ProtocolType	string	协议类型。枚举值： HDX：HDX协议。 ASP：阿里云自研ASP协议。	ASP
LastSessionStartTime	string	最近一次连接开始时间。	2022-08-31 06:56:45
LastSessionEndTime	string	最近一次连接结束时间。	2022-08-31 07:56:45
OsType	string	云电脑的操作系统类型。枚举值： linux：Linux操作系统。 windows：Windows操作系统。	Windows
EndUserApplyCoordinateTime	long	用户申请管理员协助时间点。	1678794261000
TerminalInfo	object	终端信息。
ProductName	string	终端类型。	Mac
SerialNumber	string	终端序列号	96c530bc-6095-4014-8bbc-d461b8ac****
Model	string	终端设备类型。	wuying_mac_x86_64
Uuid	string	终端设备 UUID。	EBFDC7773BEBAD418A9F89429652****
DirectoryType	string	办公网络类型	SIMPLE
AccountType	string	账号类型	SIMPLE
NextToken	string	下一页查询开始的 Token。	caeba0bbb2

示例

正常返回示例

JSON格式

{
  "RequestId": "D0920845-7359-59FC-9899-B****",
  "TotalCount": 15,
  "Sessions": [
    {
      "EndUserId": "alice",
      "DesktopGroupId": "dg-iaqu3bi2xtie****",
      "DesktopGroupName": "DemoCCGroup",
      "OfficeSiteId": "cn-hangzhou+dir-8904****",
      "OfficeSiteName": "DemoOfficeNetwork",
      "OwnType": 0,
      "SessionStatus": "Connected",
      "DesktopId": "ecd-g6t1ukbaea****",
      "ClientOS": "windows",
      "ClientVersion": "7.8.0",
      "ClientIp": "172.21.XX.XX",
      "LatestConnectionTime": 120,
      "TotalConnectionDuration": 120,
      "SessionIdleTime": 120,
      "ProtocolType": "ASP",
      "LastSessionStartTime": "2022-08-31 06:56:45",
      "LastSessionEndTime": "2022-08-31 07:56:45",
      "OsType": "Windows",
      "EndUserApplyCoordinateTime": 1678794261000,
      "TerminalInfo": {
        "ProductName": "Mac",
        "SerialNumber": "96c530bc-6095-4014-8bbc-d461b8ac****",
        "Model": "wuying_mac_x86_64",
        "Uuid": "EBFDC7773BEBAD418A9F89429652****"
      },
      "DirectoryType": "SIMPLE",
      "AccountType": "SIMPLE"
    }
  ],
  "NextToken": "caeba0bbb2"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-10-17	OpenAPI 返回结构发生变更	查看变更详情