全部产品
Search
文档中心

无影云桌面:API概览

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

地域

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

工作区

API标题API概述
CreateSimpleOfficeSite创建使用便捷账号的工作区创建一个使用便捷账号的工作区。
CreateADConnectorOfficeSite创建AD工作区创建一个企业AD账号的工作区。
DeleteOfficeSites销毁工作区销毁工作区。
ActivateOfficeSite激活工作区激活工作区。
ModifyOfficeSiteAttribute修改工作区属性修改工作区的可编辑属性。
ModifyOfficeSiteCrossDesktopAccess开启工作区内桌面互通开启工作区内桌面互通。开启工作区内桌面互通后,同一个工作区内的桌面之间可以实现相互访问彼此的网络。
ModifyADConnectorOfficeSite修改AD工作区修改AD工作区。
ConfigADConnectorUser配置AD工作区的OU和管理员为AD工作区指定组织单元OU和管理员。
ConfigADConnectorTrust为AD工作区配置信任关系为AD工作区配置信任关系。
ModifyOfficeSiteMfaEnabled设置AD工作区多因素认证为工作区开启或者关闭多因素认证MFA功能。
DescribeOfficeSites查询工作区的详细信息查询工作区的详细信息。
ListOfficeSiteOverview查询工作区的概览查询工作区的概览信息。
ListOfficeSiteUsers查询AD用户信息查询AD工作区对接AD域后获取的AD用户信息。
ListUserAdOrganizationUnits获取AD域的组织单元获取AD工作区对接的AD域的组织单元OU信息。

目录

API标题API概述
CreateADConnectorDirectory创建AD类型的目录创建AD类型的目录。
CreateRAMDirectory创建RAM类型的目录创建RAM类型的目录。
DeleteDirectories删除目录删除目录。
ModifyADConnectorDirectory修改AD目录修改AD目录。
DescribeDirectories查询目录的详细信息查询目录的详细信息。
ListDirectoryUsers查询AD目录对应的用户信息查询AD目录对应的用户信息。

桌面

API标题API概述
CreateDesktops创建一台或多台云桌面为用户创建一台或多台云桌面。
DeleteDesktops释放云桌面释放一台或多台按量付费云桌面或到期的包年包月云桌面。
ModifyDesktopName修改桌面名称修改一台云桌面的桌面名称。
ModifyDesktopSpec变更云桌面配置变更云桌面配置,包括修改vCPU和内存规格,以及扩容磁盘。
ModifyDesktopChargeType修改云桌面付费类型转换云桌面的计费方式。
ModifyDesktopHostName修改云桌面的主机名称修改云桌面的主机名称。
ModifyUserEntitlement为便捷用户分配桌面为一个或多个用户同时新增或删除多个云桌面的授权。
ModifyEntitlement为桌面重新分配用户为桌面重新分配用户。
ModifyDesktopTimer创建或修改桌面定时任务创建或修改桌面定时任务。
DisableDesktopsInGroup禁用桌面组中的桌面将桌面组桌面设置为 unavailable。
StartDesktops启动一台或者多台已停止的云桌面启动一台或者多台已停止的云桌面。接口调用成功后,云桌面进入运行中状态。
StopDesktops停止一台或者多台运行中的云桌面停止一台或者多台运行中的云桌面。接口调用成功后,云桌面进入已停止状态。
RebootDesktops重启云桌面重启一台或者多台云桌面。
RebuildDesktops重建云桌面重建云桌面实例。
ResetDesktops重置桌面组内的云桌面重置桌面组内的云桌面实例。
RenewDesktops续费云桌面续费一台或者多台包年包月云桌面。
ModifyCustomizedListHeaders修改桌面列表表头的显示类型修改桌面列表表头的显示类型(包括必选、显示和隐藏)。
DescribeDesktops查询云桌面详细信息查询云桌面详细信息。
DescribeDesktopTypes查询云桌面规格详细信息查询云桌面规格详细信息。
DescribeCustomizedListHeaders获取桌面列表表头获取桌面列表页的表头信息。
ExportDesktopListInfo导出桌面列表导出桌面列表。
GetConnectionTicket获取连接凭证获取桌面连接凭证。
DescribeUsersPassword查询用户密码查询用户密码。
MigrateDesktops桌面迁移工作区迁移云桌面,从当前所属工作区迁移到目标工作区。

桌面组

API标题API概述
CreateDesktopGroup创建桌面组创建一个桌面组。
DeleteDesktopGroup释放桌面组释放桌面组。
ModifyDesktopGroup修改桌面组修改桌面组。
AddUserToDesktopGroup添加用户到桌面组增加桌面组的授权用户。
ModifyUserToDesktopGroup修改桌面组用户授权修改桌面组用户授权。
RemoveUserFromDesktopGroup从桌面组中移除用户移除桌面组的用户授权。
DescribeDesktopGroups查询桌面组获取桌面组列表。
DescribeDesktopsInGroup查询桌面组的桌面按付费类型查询桌面组包含的桌面列表。
DescribeUsersInGroup列举桌面组授权用户获取桌面组的授权用户列表。
DescribeUserConnectionRecords获取桌面组用户连接记录获取桌面组中用户连接桌面的记录。
ExportDesktopGroupInfo导出桌面组列表导出桌面组列表。
GetDesktopGroupDetail获取桌面组详情获取某一个桌面组的详细信息。
SetDesktopGroupScaleTimer设置桌面组自动扩缩计划为多会话桌面设置自动扩缩策略。多会话桌面允许多个用户共用一个桌面,因此可节省成本。
SetDesktopGroupTimer设置桌面组定时任务设置桌面组定时任务。
SetDesktopGroupTimerStatus设置桌面组定时任务状态设置桌面组定时任务状态。

网络

API标题API概述
CreateNetworkPackage创建互联网访问包创建一个互联网访问包,为工作区开通互联网访问功能。
DeleteNetworkPackages删除互联网访问包删除一个或者多个互联网访问包,即关闭互联网访问功能。
DetachCen解除工作区与云企业网的绑定关系解除工作区网络与云企业网实例之间的绑定关系。
AttachCen将工作区加入到云企业网将工作区网络加入到云企业网实例中。
AssociateNetworkPackage绑定工作区与网络包将网络包绑定至工作区。网络包和工作区是一对一的绑定关系。
DissociateNetworkPackage解绑工作区与网络包将网络包从此前绑定的工作区解绑。
RenewNetworkPackages固定带宽网络包续费为固定带宽网络包续费。
ModifyNetworkPackageBandwidth修改网络包带宽值修改网络包带宽值。
ModifyNetworkPackageEnabled恢复或停用互联网访问包恢复或停用互联网访问。
DescribeNetworkPackages查询互联网访问包详细信息查询一个或者多个互联网访问包的详细信息。
DescribeFlowMetric查询桌面的流入带宽和流出带宽查询桌面的流入带宽和流出带宽,或是整个工作区的公网访问流入带宽和流出带宽监控数据。
DescribeFlowStatistic获取工作区下桌面粒度流量统计获取单一工作区下桌面粒度的流量统计。
DescribeCens查询云企业网实例信息查询账号下所有云企业网实例信息。
VerifyCen校验云企业网校验云企业网实例ID与所属阿里云账号ID是否正确,及实例路由是否与工作区IPv4网段存在网段冲突。
SendVerifyCode获取验证码获取验证码。

MFA

API标题API概述
DeleteVirtualMFADevice删除多因素认证设备删除虚拟MFA设备。
UnlockVirtualMFADevice解锁虚拟MFA设备解锁处于锁定(LOCKED)状态的虚拟MFA设备。
LockVirtualMFADevice锁定虚拟MFA设备锁定处于正常(NORMAL)状态的虚拟MFA设备。
DescribeVirtualMFADevices查询多因素认证设备查询AD用户绑定的多因素认证设备。

存储

API标题API概述
共享存储NAS共享存储NAS
DescribeKmsKeys查询用户KMS密钥列表查询用户KMS密钥列表。如果是第一次访问,将尝试创建一个EDS的服务密钥,并返回结果。
CreateAndBindNasFileSystem创建并绑定nas文件系统创建nas文件系统并且绑定到桌面组的工作区。
ModifyDiskSpec修改磁盘性能等级变更云桌面配置,包括修改vCPU和内存规格,扩容磁盘,以及添加磁盘。
ResetNASDefaultMountTarget重置NAS文件系统的挂载点重置NAS文件系统的挂载点。
ModifyNASDefaultMountTarget修改NAS文件系统的挂载点修改NAS文件系统的挂载点。
DescribeNASFileSystems查询NAS文件系统信息查询NAS文件系统信息。
CreateDiskEncryptionService开启磁盘加密功能开启磁盘加密功能,在用户RAM下添加无影云盘加密的服务关联角色(SLR)。
DeleteNASFileSystems删除NAS文件系统删除一个或者多个NAS文件系统。
CreateNASFileSystem创建NAS文件系统创建一个NAS文件系统。

安全

API标题API概述
漏洞修复漏洞修复
OperateVuls批量处理漏洞批量处理漏洞。
ModifyOperateVul处理检测出的漏洞对检测出的漏洞进行处理,包括修复、验证或者忽略漏洞。
StartVirusScanTask触发病毒扫描手动触发病毒扫描。
DescribeVulList查询漏洞信息查询漏洞信息。
DescribeVulOverview查询待修复漏洞查询待修复漏洞的整体情况,包括各等级漏洞的数量。
DescribeVulDetails查询漏洞详情查询漏洞详情。
DescribeGroupedVul查询某个工作区下的漏洞查询某个工作区下云桌面检测出的漏洞信息。
DescribeFrontVulPatchList查询当前漏洞的前置漏洞信息查询当前漏洞的前置漏洞补丁信息。
DescribeDesktopIdsByVulNames查询检测出漏洞的云桌面列表查询检测出漏洞的云桌面列表。
DescribeScanTaskProgress查询病毒扫描任务的状态查询病毒扫描任务的状态。
安全告警安全告警
HandleSecurityEvents批量处理安全告警批量处理安全告警。
RollbackSuspEventQuaraFile撤销对文件隔离箱中文件的隔离撤销对文件隔离箱中文件的隔离。
DescribeAlarmEventStackInfo查询安全告警详情查询安全告警详情。
DescribeSecurityEventOperations查询安全告警操作列表查询可以对安全告警进行处理的操作列表。
DescribeSecurityEventOperationStatus查询安全告警的处理状态查询安全告警的处理状态。
DescribeSuspEventOverview查询各等级安全告警的数量查询某一地域下各等级安全告警的数量。
DescribeSuspEventQuaraFiles查询文件隔离箱中的文件查询文件隔离箱中被隔离的文件。
DescribeSuspEvents查询异常事件信息查询异常事件信息。

模板

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

镜像

API标题API概述
CreateImage创建自定义镜像通过已部署好的云桌面创建自定义镜像,以便创建更多包含相同配置的云桌面,免除重复配置。
UploadImage上传自定义镜像上传用户自定义镜像。
CopyImage跨地域复制镜像将同账号下的一个镜像复制至另一地域。
DeleteImages删除一个或多个自定义镜像删除一个或多个自定义镜像。
CancelCopyImage取消跨地域复制镜像取消将同账号下的一个镜像复制至另一地域的操作。
ModifyImageAttribute修改镜像属性修改镜像属性。
ModifyImagePermission共享或取消共享镜像将镜像共享给无影的其他用户或者取消已经共享的镜像。
DescribeImages查询镜像的详细信息查询镜像的详细信息。
DescribeImageModifiedRecords查询镜像变更记录查询桌面的镜像变更记录。
DescribeImagePermission获取镜像已共享的阿里云账号列表获取当前镜像已共享的阿里云账号列表。

快照

API标题API概述
CreateSnapshot为云桌面的磁盘创建一份快照为云桌面的磁盘创建一份快照。
DeleteSnapshot删除一份或多份快照用于删除一份或多份快照。
ResetSnapshot恢复快照对应的磁盘数据恢复快照对应的磁盘数据。
DescribeSnapshots查询云桌面的快照列表和详细信息查询一台云桌面的快照列表和快照的详细信息。
CancelAutoSnapshotPolicy取消自动快照策略取消云桌面的自动快照策略。
ModifyAutoSnapshotPolicy修改自动快照策略修改自动快照策略。
DeleteAutoSnapshotPolicy删除自动快照策略删除自动快照策略。
DescribeAutoSnapshotPolicy查询自动快照策略查询自动快照策略。
CreateAutoSnapshotPolicy创建自动快照策略根据Cron表达式自定义快照策略。
ApplyAutoSnapshotPolicy自动快照策略关联桌面关联需要创建自动快照策略的桌面。

策略

API标题API概述
CreatePolicyGroup创建策略创建策略。
ClonePolicyGroup克隆策略克隆策略。
DeletePolicyGroups删除一个或多个自定义策略删除一个或多个自定义策略。
ModifyPolicyGroup修改策略修改策略。
ModifyDesktopsPolicyGroup为云桌面重新分配策略为云桌面重新分配策略。
DescribePolicyGroups查询策略详细信息查询策略的详细信息。

OTA

API标题API概述
ApproveFotaUpdate允许升级镜像允许升级镜像。
UpdateFotaTask更新镜像升级任务的自动推送设置更新镜像升级任务的自动推送设置。
DescribeFotaTasks获取镜像升级任务列表获取镜像升级任务列表。
DescribeFotaPendingDesktops获取待升级桌面信息获取可升级到TaskUid对应版本镜像但尚未升级的桌面信息。

SSO设置

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

云助手

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

标签

API标题API概述
TagResources为资源打标签为指定的资源创建并绑定标签。
UntagResources删除资源标签为指定的云桌面解绑标签。解绑后,如果该标签没有绑定任何资源,会被自动删除。
ListTagResources查询指定资源已绑定的标签列表查询指定资源已绑定的标签列表。

审计

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

终端管理

API标题API概述
DeleteDevices删除设备删除软、硬终端设备。
AttachEndUser绑定用户设备绑定用户。
DetachEndUser解绑用户解绑用户。
DescribeDevices查询设备列表查询可信设备接口。
AddDevices添加设备添加可信设备。

其他

API标题API概述
SetDirectorySsoStatusSetDirectorySsoStatus设置AD目录的SSO状态。
WakeupDesktops唤醒桌面对云桌面执行唤醒操作。
HibernateDesktops休眠桌面对云桌面执行休眠操作。