API概览

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

地域

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

工作区

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

目录

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

桌面

API标题API概述
CreateDesktops创建一台或多台云桌面调用CreateDesktops为用户创建一台或多台云桌面。
DeleteDesktops释放云桌面调用DeleteDesktops释放一台或多台按量付费云桌面或到期的包年包月云桌面。
ModifyDesktopName修改桌面名称调用ModifyDesktopName修改一台云桌面的桌面名称。
ModifyDesktopSpec变更云桌面配置调用ModifyDesktopSpec变更云桌面配置,包括修改vCPU和内存规格,以及扩容磁盘。
ModifyDesktopChargeType修改云桌面付费类型调用ModifyDesktopChargeType转换云桌面的计费方式。
ModifyDesktopHostName修改云桌面的主机名称调用ModifyDesktopHostName修改云桌面的主机名称。
ModifyUserEntitlement为便捷用户分配桌面调用ModifyUserEntitlement为一个或多个用户同时新增或删除多个云桌面的授权。
ModifyEntitlement为桌面重新分配用户调用ModifyEntitlement为桌面重新分配用户。
DisableDesktopsInGroup禁用桌面组中的桌面
StartDesktops启动一台或者多台已停止的云桌面调用StartDesktops启动一台或者多台已停止的云桌面。接口调用成功后,云桌面进入运行中状态。
StopDesktops停止一台或者多台运行中的云桌面调用StopDesktops停止一台或者多台运行中的云桌面。接口调用成功后,云桌面进入已停止状态。
RebootDesktops重启云桌面调用RebootDesktops重启一台或者多台云桌面。
RebuildDesktops重建云桌面调用RebuildDesktops重建云桌面实例。
ResetDesktops重置桌面组内的云桌面调用ResetDesktops重置桌面组内的云桌面实例。
RenewDesktops续费云桌面调用RenewDesktops续费一台或者多台包年包月云桌面。
DescribeDesktops查询云桌面详细信息调用DescribeDesktops查询云桌面详细信息。
DescribeDesktopTypes查询云桌面规格详细信息调用DescribeDesktopTypes查询云桌面规格详细信息。
ExportDesktopListInfo导出桌面列表调用ExportDesktopListInfo导出桌面列表。
GetConnectionTicket获取连接凭证获取桌面连接凭证。

桌面组

API标题API概述
CreateDesktopGroup创建桌面组调用CreateDesktopGroup创建一个桌面组。
DeleteDesktopGroup释放桌面组调用DeleteDesktopGroup释放桌面组。
ModifyDesktopGroup修改桌面组调用ModifyDesktopGroup修改一个桌面组。
AddUserToDesktopGroup添加用户到桌面组调用AddUserToDesktopGroup增加桌面组的授权用户。
ModifyUserToDesktopGroup修改桌面组用户授权调用ModifyUserToDesktopGroup修改桌面组用户授权。
RemoveUserFromDesktopGroup从桌面组中移除用户调用RemoveUserFromDesktopGroup移除桌面组的用户授权。
DescribeDesktopGroups查询桌面组调用DescribeDesktopGroups获取桌面组列表。
DescribeDesktopsInGroup查询桌面组的桌面调用DescribeDesktopsInGroup按付费类型查询桌面组包含的桌面列表。
DescribeUsersInGroup列举桌面组用户调用DescribeUsersInGroup获取桌面组的授权用户列表。
DescribeUserConnectionRecords获取桌面组用户连接记录调用DescribeUserConnectionRecords获取桌面组中用户连接桌面的记录。
ExportDesktopGroupInfo导出桌面组列表调用ExportDesktopGroupInfo导出桌面组列表。
GetDesktopGroupDetail获取桌面组详情调用GetDesktopGroupDetail获取某一个桌面组的详细信息。

网络

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

存储

API标题API概述
CreateNASFileSystem创建NAS文件系统调用CreateNASFileSystem创建一个NAS文件系统。
CreateDiskEncryptionService开启磁盘加密功能调用CreateDiskEncryptionService开启磁盘加密功能,在用户RAM下添加无影云盘加密的服务关联角色(SLR)。
DeleteNASFileSystems删除NAS文件系统调用DeleteNASFileSystems删除一个或者多个NAS文件系统。
ModifyNASDefaultMountTarget修改NAS文件系统的挂载点调用ModifyNASDefaultMountTarget修改NAS文件系统的挂载点。
ResetNASDefaultMountTarget重置NAS文件系统的挂载点调用ResetNASDefaultMountTarget重置NAS文件系统的挂载点。
DescribeNASFileSystems查询NAS文件系统信息调用DescribeNASFileSystems查询NAS文件系统信息。
DescribeKmsKeys查询用户KMS密钥列表调用DescribeKmsKeys查询用户KMS密钥列表。如果是第一次访问,将尝试创建一个EDS的服务密钥,并返回结果。

安全

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

桌面模板

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

镜像

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

快照

API标题API概述
CreateSnapshot为云桌面的磁盘创建一份快照调用CreateSnapshot为云桌面的磁盘创建一份快照。
DeleteSnapshot删除一份或多份快照用于删除一份或多份快照。
ResetSnapshot恢复快照对应的磁盘数据调用ResetSnapshot恢复快照对应的磁盘数据。
DescribeSnapshots查询云桌面的快照列表和详细信息调用DescribeSnapshots查询一台云桌面的快照列表和快照的详细信息。

策略

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

OTA

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

多因素认证MFA

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

SSO设置

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

云助手

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

标签

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

审计

API标题API概述
DescribeClientEvents查询终端用户的操作日志调用DescribeClientEvents查询终端用户的操作日志。为提高安全性,您可以按需审计终端用户的操作日志,支持查询的操作日志包括桌面开机、桌面关机、桌面会话断开等事件。
ExportClientEvents导出客户端事件列表调用ExportClientEvents导出客户端事件列表。
阿里云首页 无影云桌面 相关技术圈