无影云桌面相关API接口概览_无影云电脑企业版(EDS)-阿里云帮助中心

本产品（无影云电脑/2020-09-30）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用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	设置云电脑维护模式	设置云电脑维护模式。

地域

询价