DescribeDesktopSessions_无影云电脑_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

当前仅支持查询 30 天以内的数据。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ecd:DescribeDesktopSessions
List
全部资源
*

请求参数

字段名称字段详情
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

示例值:cn-hangzhou
OfficeSiteIdstring

办公网络 ID。

示例值:cn-hangzhou+dir-363353****参考取值来源:
    DescribeOfficeSites
    ListOfficeSiteOverview
    CreateSimpleOfficeSite
EndUserIdstring

终端用户 ID。

示例值:alice参考取值来源:
    DescribeUsersInGroup
SessionStatusstring

会话连接状态。

示例值:Connected枚举值:ConnectedDisconnected
StartTimestring

查询开始时间。

示例值:2023-01-28T02:31:43Z
EndTimestring

查询结束时间。

示例值:2023-02-13T02:51:43Z
PageNumberinteger<int32>

分页查询时,当前页的页码。

示例值:1
PageSizeinteger<int32>

分页查询时,每页最大行数。

示例值:10
DesktopIdarray<string>

云电脑 ID。可设置 1~100 个。

子级条数 <= 100
DesktopNamestring

云电脑名称。

示例值:DemoComputer参考取值来源:
    DescribeDesktops
SubPayTypestring

云电脑购买方式。

示例值:monthPackage枚举值:durationpostPaidmonthPackageprePaid
CheckOsSessionboolean

检查云电脑内会话状态的开关。

示例值:true
EndUserIdFilterstring

终端用户 ID。与参数EndUserId相同,两者只需要传入一个即可。

示例值:alice

返回参数

字段名称字段详情
TotalCountinteger<int32>

查询结果总数。

示例值:1
RequestIdstring

请求 ID。

示例值:3EC4A6DB-EC8D-55B0-9038-543DE671****
Sessionsarray<object>

会话详情。

返回示例

变更历史

变更时间变更内容概要操作
2024-12-09
新增请求参数EndUserIdFilter
2024-07-08
新增请求参数CheckOsSession
变更返回参数
2024-07-01
新增请求参数SubPayType
变更返回参数
2024-04-15
新增请求参数DesktopId
新增请求参数DesktopName
删除返回参数

相关示例