QueryEndUserHistoryUsage - 查询终端用户历史使用时长-无影云电脑企业版-阿里云帮助中心

查询租户下各终端用户在指定日期范围内的使用时长排行与明细。聚合离线统计数据，按用户维度汇总连接时长，并为当前页用户填充基本信息和每台桌面的使用时长明细。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecd:QueryEndUserHistoryUsage

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
StartDate	string	否	查询开始日期，格式为 yyyy-MM-dd。不能早于 32 天前，默认为昨天。	2024-01-01
EndDate	string	否	查询结束日期，格式为 yyyy-MM-dd。不能晚于昨天且不能早于 StartDate，默认为昨天。	2024-01-15
IsAdUser	boolean	否	是否查询 AD 域用户。取值为 true 时查询 AD 域用户，取值为 false 或不传时查询便捷账号用户。
PageNum	integer	否	页码，最小值为 1，默认为 1。	1
PageSize	integer	否	每页大小，取值范围为 1~100，默认为 100。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求唯一标识。	269BDB16-2CD8-4865-84BD-11C40BC21DB0
TotalCount	integer	符合条件的用户总数。	50
UserUsageInfoList	array<object>	当前页用户使用时长列表。
	array<object>
Description	string	用户备注，仅便捷用户有值。	测试用户
DesktopUsageList	array<object>	各桌面使用时长明细列表。
	object
DesktopId	string	桌面 ID。	ecd-abc123
DesktopName	string	桌面名称。	DemoDesktop
Duration	integer	该用户在该桌面上的使用时长，单位为秒。	1800
DisplayName	string	用户显示名。便捷用户为真实昵称，AD 用户为显示名。	张三
Duration	integer	总使用时长，单位为秒。	3600
EndUserId	string	终端用户 ID。	user01
EndUserName	string	用户名。便捷用户为昵称，AD 用户为 UserPrincipalName。	zhangsan
OrgPathList	array	组织路径列表。便捷用户为多个组织路径，AD 用户为 OU 路径。
	string	组织路径。	/研发部/前端组
UserGroupList	array<object>	用户组列表，仅便捷用户有值。
	object
UserGroupId	string	用户组 ID。	ug-12345678
UserGroupName	string	用户组名称。	默认用户组

示例

正常返回示例

JSON格式

{
  "RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0",
  "TotalCount": 50,
  "UserUsageInfoList": [
    {
      "Description": "测试用户",
      "DesktopUsageList": [
        {
          "DesktopId": "ecd-abc123",
          "DesktopName": "DemoDesktop",
          "Duration": 1800
        }
      ],
      "DisplayName": "张三",
      "Duration": 3600,
      "EndUserId": "user01",
      "EndUserName": "zhangsan",
      "OrgPathList": [
        "/研发部/前端组"
      ],
      "UserGroupList": [
        {
          "UserGroupId": "ug-12345678",
          "UserGroupName": "默认用户组"
        }
      ]
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。