文档

API概览

更新时间:
本产品(无影云电脑/2020-09-30)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

地域

API标题API概述
DescribeRegions查看可选的地域和可用区查询无影云桌面支持的阿里云地域信息。
DescribeZones查询指定地域支持的可用区查询无影云电脑在某一个阿里云地域下支持的可用区信息。

询价

API标题API概述
DescribePrice查询新购价格查询无影商品的新购价格。
DescribeRenewalPrice查询续费价格查询无影商品的续费价格。
DescribeModificationPrice查询变配价格查询无影商品的变配价格。
DescribeRefundPrice查询按月购买云电脑的退订价格查询按月购买云电脑的退订价格。

办公网络(原工作区)

API标题API概述
办公网络通用办公网络通用
ListOfficeSiteOverview查询办公网络的概览信息查询办公网络(原工作区)的概览信息,包括状态、云电脑数量、VPC网络类型等。
DescribeOfficeSites查询办公网络的详细信息查询办公网络的所有属性,包括ID、名称、状态、创建时间等。
ModifyOfficeSiteAttribute修改办公网络属性修改办公网络(原工作区)的基本属性,例如办公网络名称、是否为使用云电脑的用户赋予本地管理员权限等。
ModifyOfficeSiteCrossDesktopAccess设置办公网络内云电脑的互通性开启或关闭办公网络(原工作区)内云电脑互通。开启后,同一个办公网络内的云电脑之间可以实现相互访问彼此的网络。
DeleteOfficeSites删除办公网络将办公网络(原工作区)内的云电脑资源完全释放后可以将办公网络删除。
基于便捷账号的办公网络基于便捷账号的办公网络
CreateSimpleOfficeSite创建基于便捷账号的办公网络无影云电脑支持便捷账号和企业AD账号这两种账号体系。本接口用于创建一个基于便捷账号的办公网络(原工作区)。
ActivateOfficeSite解锁办公网络基于便捷账号的办公网络闲置一定时间后将被自动锁定。调用本接口可解锁。
基于企业AD账号的办公网络基于企业AD账号的办公网络
CreateADConnectorOfficeSite创建基于企业AD账号的办公网络无影云电脑支持便捷账号和企业AD账号这两种账号体系。本接口用于创建一个基于企业AD账号的办公网络(原工作区)。
ListUserAdOrganizationUnits获取AD域的组织单元获取AD办公网络(原工作区)对接的AD域的组织单元OU信息。
ListOfficeSiteUsers查询AD账号信息查询AD办公网络(原工作区)对接AD域后获取的AD账号信息。
ModifyADConnectorOfficeSite修改AD办公网络修改AD办公网络(原工作区)的基本属性,例如办公网络名称、企业AD子域的域名等。
ModifyOfficeSiteMfaEnabled设置AD办公网络的多因素认证为AD办公网络(原工作区)开启或者关闭多因素认证MFA。
ConfigADConnectorTrust为AD办公网络配置信任关系对于采用HDX协议的办公网络(原工作区),需要配置条件转发器和信任关系后方可正常使用。可调用本接口为AD办公网络配置信任关系。
ConfigADConnectorUser配置AD办公网络的组织单元OU和管理员为AD办公网络(原工作区)指定组织单元OU和管理员。

目录

API标题API概述
CreateADConnectorDirectory创建AD类型的目录创建AD类型的目录。
CreateRAMDirectory创建RAM类型的目录创建RAM类型的目录。
DescribeDirectories查询目录的详细信息查询目录的详细信息。
ListDirectoryUsers查询AD目录对应的用户信息如果您使用AD目录来对接企业自有AD,调用该接口可以获取企业AD中的用户信息。
ModifyADConnectorDirectory修改AD目录修改AD目录。
DeleteDirectories删除目录删除一个或多个目录。

云电脑

API标题API概述
云电脑资源云电脑资源
CreateDesktops创建一台或多台云电脑创建一台或多台云电脑。创建时若传入用户信息,可直接完成云电脑的分配。
DescribeDesktopInfo查询云电脑基础信息查询云电脑的基础信息。
DescribeDesktops查询云电脑详细信息查询云电脑的详细信息。
DescribeDesktopTypes查询云电脑规格详细信息查询云电脑规格的详细信息。
DescribeCustomizedListHeaders获取云电脑列表表头获取云电脑列表页的表头信息。
ExportDesktopListInfo导出云电脑列表将云电脑列表导出为CSV文件。
StartDesktops启动一台或者多台已停止的云电脑启动一台或者多台已停止的云电脑。接口调用成功后,云电脑进入运行中状态。
HibernateDesktops休眠一台或多台云电脑对云电脑执行休眠操作。
WakeupDesktops唤醒一台或多台云电脑对云电脑执行唤醒操作。
StopDesktops停止一台或者多台运行中的云电脑停止一台或者多台运行中的云电脑。接口调用成功后,云电脑进入已停止状态。
RebootDesktops重启一台或多台云电脑重启一台或者多台云电脑。
RebuildDesktops重建一台或多台云电脑重建云电脑实例。
ModifyDesktopName修改云电脑名称将指定云电脑的名称修改为新名称。
ModifyDiskSpec修改磁盘性能等级变更云桌面配置,包括修改vCPU和内存规格,扩容磁盘,以及添加磁盘。
ModifyDesktopChargeType修改云电脑付费类型将云电脑的付费类型转为包年包月或按量付费。
ModifyDesktopSpec变更云电脑配置变更云电脑的规格和扩容磁盘。
ModifyDesktopTimer创建或修改云电脑定时任务创建或修改云电脑定时任务,例如定时开机、关机、重启、重置等。
ModifyDesktopHostName修改AD办公网络下Windows云电脑的主机名称修改AD办公网络下的Windows云电脑的主机名称。
ModifyCustomizedListHeaders修改云电脑列表页表头的显示类型修改云电脑列表页表头的显示类型(包括必选、显示和隐藏)。
MigrateDesktops将云电脑迁移至其他办公网络将云电脑从当前所属办公网络(原工作区)迁移到新的办公网络。
RenewDesktops续费按月购买云电脑续费一台或者多台按月购买云电脑。
DeleteDesktops释放云电脑释放一台或多台按量付费云电脑或到期的包年包月云电脑。
云电脑授权用户云电脑授权用户
DescribeUsersPassword查询云电脑授权用户的密码查询指定云电脑的授权用户的密码。
GetConnectionTicket获取连接凭证获取云电脑连接凭证。
DescribeGuestApplications查询云电脑指定用户的应用和进程信息查询云电脑指定授权用户的应用和进程信息。
ModifyUserEntitlement为便捷用户新增或删除云电脑授权为一个或多个用户新增或删除指定的一台或多台云电脑的授权。
ModifyEntitlement为云电脑重新选择授权用户将云电脑分配给指定用户,同时移除该云电脑此前已有的所有授权用户。

云电脑池(原桌面组)

API标题API概述
云电脑池资源云电脑池资源
CreateDesktopGroup创建云电脑池创建一个云电脑池。
GetDesktopGroupDetail获取云电脑池详情获取一个云电脑池的详细信息。
DescribeDesktopGroups查询云电脑池列表及详情查询云电脑池列表及详情。
ExportDesktopGroupInfo导出云电脑池列表调用本接口导出的云电脑池列表将保存为XLSX文件。每条云电脑池数据包括云电脑池ID和名称、办公网络ID和名称、云电脑池模板、安全策略名称等。
DescribeDesktopsInGroup查询云电脑池内的云电脑按付费类型查询云电脑池包含的云电脑列表。
DisableDesktopsInGroup禁用云电脑池中的云电脑禁用云电脑池中的云电脑。禁用后,云电脑的状态变为unavailable。
ModifyDesktopGroup修改云电脑池修改云电脑池。
ResetDesktops重置池化云电脑重置云电脑池内的云电脑。
SetDesktopGroupScaleTimer为多会话云电脑设置自动扩缩策略为多会话云电脑设置自动扩缩策略。多会话云电脑允许多个用户同时连接同一台云电脑,可节省成本。
SetDesktopGroupTimer设置云电脑池定时任务设置云电脑池定时任务,执行定时开机、关机、重启或重置任务。
SetDesktopGroupTimerStatus设置云电脑池定时任务的状态设置云电脑池定时任务的状态,例如将定时任务设为启用或禁用。
RenewDesktopGroup续费包年包月云电脑池为包年包月云电脑池续费。
DeleteDesktopGroup释放云电脑池释放云电脑池。
云电脑池授权用户云电脑池授权用户
AddUserToDesktopGroup为云电脑池添加授权用户为云电脑池添加授权用户。云电脑池内的云电脑会按照管理员设置的规则自动分配给授权用户使用。
DescribeUsersInGroup查询云电脑池授权用户详情查询云电脑池所有授权用户的详情,包括用户名、邮箱地址、手机号、获得授权的云电脑ID等。
DescribeUserConnectionRecords查询云电脑池的用户连接记录查询云电脑池的授权用户连接池化云电脑的具体记录。
ModifyUserToDesktopGroup为云电脑池替换授权用户将云电脑池的指定授权用户替换为其他指定授权用户。
RemoveUserFromDesktopGroup为云电脑池移除授权用户将云电脑池的指定授权用户移除出去。被移除的用户将无法再连接云电脑池内的云电脑。

公网精品带宽

API标题API概述
CreateNetworkPackage为办公网络创建公网精品带宽为办公网络创建一个公网精品带宽。
DescribeNetworkPackages查询公网精品带宽的详细信息查询一个或者多个公网精品带宽的详细信息。
DescribeFlowMetric查询流入带宽和流出带宽查询云电脑的流入带宽和流出带宽,或是公网精品带宽的公网访问流入带宽和流出带宽监控数据。
DescribeFlowStatistic获取办公网络下云电脑粒度的流量统计获取单一办公网络下云电脑粒度的流量统计数据。
DescribeAclEntries查询公网访问控制策略详情查询办公网络或云电脑粒度上的公网访问控制策略详情。
ModifyAclEntries修改公网访问控制策略修改办公网络或云电脑粒度上的公网访问控制策略。
AssociateNetworkPackage为办公网络绑定公网精品带宽将公网精品带宽绑定至办公网络。公网精品带宽和办公网络是一对一的绑定关系。
DissociateNetworkPackage从办公网络解绑公网精品带宽将公网精品带宽与此前绑定的办公网络解绑。
RenewNetworkPackages续费包年包月公网精品带宽为包年包月公网精品带宽续费。
ModifyNetworkPackageBandwidth修改公网精品带宽的带宽大小修改公网精品带宽的带宽大小。
ModifyNetworkPackageEnabled恢复或停用公网精品带宽恢复或停用公网精品带宽。
DeleteNetworkPackages删除公网精品带宽删除一个或者多个公网精品带宽。

云企业网

API标题API概述
DescribeCens查询云企业网实例信息查询账号下所有云企业网实例信息。
VerifyCen校验云企业网校验云企业网实例ID与所属阿里云账号ID是否正确,以及实例路由与办公网络IPv4网段是否存在网段冲突。
SendVerifyCode获取加入其他账号云企业网实例的验证码将高级办公网络加入其他阿里云账号下的云企业网实例时,需要调用此接口获取验证码。
AttachCen将高级办公网络与云企业网实例绑定将高级办公网络与云企业网实例绑定。
DetachCen将高级办公网络与云企业网实例解绑将高级办公网络与已加入的云企业网实例解绑。

存储

API标题API概述
企业网盘(原无影云盘)企业网盘(原无影云盘)
网盘网盘
CreateCloudDriveService创建企业网盘创建企业网盘(原无影云盘)。
团队共享盘团队共享盘
DescribeCloudDriveGroups查询团队共享盘列表查询企业网盘内所有团队共享盘的列表及基本信息。
ModifyCloudDriveGroups修改团队共享盘属性修改团队共享盘的基本属性,例如共享盘的状态、存储峰值等。
DeleteCloudDriveGroups删除团队共享盘删除团队共享盘。
用户个人盘用户个人盘
CreateCloudDriveUsers添加用户个人盘在企业网盘中添加用户个人盘。
DescribeCloudDriveUsers查询用户个人盘列表查询企业网盘内所有用户个人盘的列表及基本信息。
ModifyCloudDriveUsers修改用户个人盘属性修改用户个人盘的基本属性,例如个人盘的状态、存储峰值等。
DeleteCloudDriveUsers删除用户个人盘删除企业网盘内的用户个人盘。
权限权限
DescribeCloudDrivePermissions查询企业网盘的权限设置详情查询企业网盘的权限设置详情。
ModifyCloudDrivePermission修改用户在企业网盘与本地设备之间的文件传输权限企业网盘的默认策略是所有用户均可从本地设备上传文件至企业网盘,但不可从企业网盘下载文件至本地设备。调用本接口可添加具备例外权限的用户。
文件管理文件管理
CreateCdsFile创建文件夹或创建文件上传任务在网盘中创建文件夹或者创建文件上传任务。
CompleteCdsFile完成文件上传创建文件上传任务后,调用本接口完成上传动作。
CopyCdsFile复制文件或文件夹为网盘中的文件或文件夹制作一个副本。
ListCdsFiles查询网盘文件及获取文件下载链接查询网盘中的文件列表,以及获取文件的下载链接。
GetAsyncTask获取异步任务信息根据CopyCdsFile接口获得的AsyncTaskId返回参数获取文件夹复制异步任务的详细信息。
ModifyCdsFile修改网盘文件属性修改网盘文件或文件夹的属性,例如文件名。
MoveCdsFile移动网盘文件将网盘中的文件或文件夹移动至新的位置。
DownloadCdsFile下载云盘文件获取目标文件的下载链接。
DeleteCdsFile删除网盘文件删除网盘中的文件或文件夹。
文件分享文件分享
CreateCdsFileShareLink创建文件分享创建文件分享。
DescribeCdsFileShareLinks查询文件分享查询文件分享。
ModifyCdsFileShareLink修改文件分享修改文件分享的设置。
CancelCdsFileShareLink取消文件分享取消文件分享。
文件夹共享文件夹共享
AddFilePermission新增网盘共享文件夹在网盘内新增共享的文件夹。
ListFilePermission查询网盘共享文件夹查询网盘中的共享文件夹的权限信息。
RemoveFilePermission取消网盘文件夹共享将网盘内的文件夹取消共享。
共享存储NAS共享存储NAS
CreateAndBindNasFileSystem创建并绑定nas文件系统创建nas文件系统并且绑定到桌面组的工作区。
CreateNASFileSystem创建NAS文件系统创建一个NAS文件系统。
DescribeNASFileSystems查询NAS文件系统信息查询NAS文件系统信息。
ModifyNASDefaultMountTarget修改NAS文件系统的挂载点修改NAS文件系统的挂载点。
ResetNASDefaultMountTarget重置NAS文件系统的挂载点重置NAS文件系统的挂载点。
DeleteNASFileSystems删除NAS文件系统删除一个或者多个NAS文件系统。

模板

API标题API概述
CreateBundle创建自定义云电脑模板创建自定义的云电脑模板。
DescribeBundles查询云电脑模板的详细信息查询云电脑模板的详细信息。
ModifyBundle修改自定义云电脑模板修改自定义云电脑模板。
DeleteBundles删除一个或多个自定义云电脑模板删除一个或多个自定义云电脑模板。

镜像

API标题API概述
CreateImage创建自定义镜像通过已部署好的云电脑创建自定义镜像,以便快速创建更多相同配置的云电脑,避免每次创建时重复配置。
CopyImage跨地域复制镜像将镜像复制到另一地域。如需跨地域分享镜像,可以先调用本接口将镜像复制到新地域再进行分享。
UploadImage上传自定义Windows镜像上传用户的自定义Windows镜像。
DescribeImages查询镜像的详细信息查询镜像的详细信息。
DescribeImageModifiedRecords查询镜像变更记录查询云电脑的镜像变更记录。
DescribeImagePermission获取镜像已共享的阿里云账号列表获取当前镜像已共享的阿里云账号列表。
ModifyImageAttribute修改镜像属性修改镜像的属性,包括镜像的名称和描述。
ModifyImagePermission共享或取消共享镜像将镜像共享给无影的其他用户或者取消已经共享的镜像。
MigrateImageProtocol迁移镜像协议将镜像的协议升级为ASP协议。
DeleteImages删除一个或多个自定义镜像删除一个或多个自定义镜像。
CancelCopyImage取消跨地域复制镜像取消将镜像复制至另一地域的操作。

快照

API标题API概述
快照管理快照管理
CreateSnapshot为云电脑的磁盘创建一份快照为云电脑的磁盘创建一份快照,用于备份和恢复磁盘上的数据。
ResetSnapshot恢复快照对应的磁盘数据恢复快照对应的磁盘数据。
DescribeSnapshots查询云电脑的快照列表和详细信息查询一台云电脑的快照列表和快照的详细信息。
DeleteSnapshot删除一份或多份快照用于删除一份或多份快照。
自动快照策略自动快照策略
CreateAutoSnapshotPolicy创建自动快照策略创建自动快照策略,让云电脑按照Cron表达式对应的时间自动创建快照。
DescribeAutoSnapshotPolicy查询自动快照策略查询自动快照策略。
ApplyAutoSnapshotPolicy将自动快照策略关联至云电脑为云电脑绑定自动快照策略。绑定后,云电脑将按照自动快照策略规定的时间自动创建快照。
ModifyAutoSnapshotPolicy修改自动快照策略修改自动快照策略的配置项,包括策略名称、快照保留时间等。
CancelAutoSnapshotPolicy取消自动快照策略取消云电脑的自动快照策略。
DeleteAutoSnapshotPolicy删除自动快照策略删除自动快照策略。

策略

API标题API概述
CreatePolicyGroup创建云电脑策略创建云电脑策略。
DeletePolicyGroups删除一个或多个自定义云电脑策略删除一个或多个自定义云电脑策略。
ModifyPolicyGroup修改云电脑策略修改云电脑策略。
ModifyDesktopsPolicyGroup为云电脑更换绑定的云电脑策略为云电脑更换绑定的云电脑策略。
DescribePolicyGroups查询云电脑策略详细信息查询云电脑策略的详细信息。
ClonePolicyGroup克隆云电脑策略通过克隆云电脑策略来实现快速创建自定义云电脑策略的目的。

MFA

API标题API概述
DeleteVirtualMFADevice删除AD账号绑定的虚拟MFA设备删除AD账号绑定的虚拟MFA设备。
DescribeVirtualMFADevices查询AD账号绑定的虚拟MFA设备查询AD账号绑定的虚拟MFA设备。
UnlockVirtualMFADevice解锁虚拟MFA设备解锁处于锁定(LOCKED)状态的虚拟MFA设备。
LockVirtualMFADevice锁定虚拟MFA设备锁定处于正常(NORMAL)状态的虚拟MFA设备。

镜像升级OTA

API标题API概述
DescribeFotaTasks获取镜像升级任务列表获取镜像升级任务列表。
DescribeFotaPendingDesktops获取待升级镜像的云电脑信息获取可升级到指定版本镜像但尚未升级的云电脑信息。
UpdateFotaTask为镜像升级任务打开或关闭自动推送为镜像升级任务打开或关闭自动推送。
ApproveFotaUpdate允许升级镜像允许升级镜像。

SSO设置

API标题API概述
SetOfficeSiteSsoStatus设置办公网络的单点登录SSO开关状态为办公网络开启或关闭单点登录SSO功能。
SetIdpMetadata上传身份提供商元数据上传基于SAML 2.0的身份提供商IdP(Identity Provider)的元数据。
SetDirectorySsoStatus设置AD办公网络的单点登录SSO开关状态为基于AD账号的办公网络开启或关闭单点登录SSO功能。
GetOfficeSiteSsoStatus查询办公网络单点登录SSO开关状态查询办公网络是否开启了单点登录SSO功能。
GetSpMetadata获取服务提供商元数据获取基于SAML 2.0的服务提供商SP(Service Provider)的元数据。

云助手

API标题API概述
StopInvocation停止命令进程停止一台或多台云桌面中一条正在进行中的云助手命令进程。
DescribeInvocations查询云助手脚本的执行列表和状态用于查询云助手脚本的执行列表和状态。
RunCommand在云桌面中执行脚本在一台或多台Windows操作系统云桌面中执行一段PowerShell或者Bat类型的脚本。

标签

API标题API概述
ListTagResources查询云电脑已添加标签的列表查询云电脑已添加标签的列表。
TagResources为云电脑添加标签为指定的云电脑添加标签,方便通过标签统一筛选和管理云电脑。
UntagResources为云电脑移除标签为云电脑移除标签。移除标签后,如果该标签没有被添加到任何云电脑上,则标签会被自动删除。

审计

API标题API概述
DescribeClientEvents查询终端用户的操作日志查询终端用户的操作日志,包括桌面开机、桌面关机、桌面会话断开等事件。
ExportClientEvents导出客户端事件列表导出客户端事件列表。

终端管理

API标题API概述
AddDevices添加可信设备添加可信设备。
DeleteDevices删除可信设备删除可信设备。
AttachEndUser为无影硬件终端添加绑定用户如果希望硬件终端只能被指定的终端用户登录,您需要开启可信设备认证功能,并为硬件终端添加绑定用户。
DetachEndUser为无影硬件终端移除绑定用户为无影硬件终端移除绑定用户。
DescribeDevices查询可信设备列表查询可信设备列表。

监控运维

API标题API概述
DescribeDesktopSessions查询云电脑会话详情查询云电脑的详细会话信息。
DescribeSessionStatistic查询会话统计查询全地域的会话统计信息。
ApplyCoordinationForMonitoring向终端用户发起远程协助请求管理员向终端用户发起远程协助请求。主要用于管理员协助场景和教育场景。
GetCoordinateTicket获取协同流凭证获取协同流凭证,用于进行远程协助或共享协同。
CancelCoordinationForMonitoring取消向终端用户发起的远程协助请求取消向终端用户发起的远程协助请求。
ApplyCoordinatePrivilege申请流协同操作权限申请流协同操作权限。
RevokeCoordinatePrivilege取消流协同操作权限取消流协同操作权限。

其他

API标题API概述
CreateDiskEncryptionService开启磁盘加密功能开启磁盘加密功能,在用户RAM下添加无影云盘加密的服务关联角色(SLR)。
DisconnectDesktopSessions断开桌面会话断开桌面会话。
DescribeKmsKeys查询用户KMS密钥列表查询用户KMS密钥列表。如果是第一次访问,将尝试创建一个EDS的服务密钥,并返回结果。
DescribeDesktopGroupSessions桌面组会话监控接口桌面组会话监控。
DescribeRecordings查询录屏详细信息查询录屏文件的详细信息。
SetDesktopMaintenance设置云电脑维护模式设置云电脑维护模式。