本文介绍无影云桌面提供的相关API接口。

桌面

API 描述
CreateDesktops 调用CreateDesktops创建一台或多台云桌面。
DescribeDesktops 调用DescribeDesktops查询云桌面的详细信息。
DescribeDesktopTypes 调用DescribeDesktopTypes查询云桌面的规格详细信息。
RebootDesktops 调用RebootDesktops重启云桌面。
StartDesktops 调用StartDesktops启动一台或者多台已停止的云桌面。
StopDesktops 调用StopDesktops停止一台或者多台运行中的云桌面。
RebuildDesktops 调用RebuildDesktops重建云桌面。
ModifyDesktopSpec 调用ModifyDesktopSpec变更云桌面配置,包括修改vCPU和内存规格,以及扩容磁盘。
ModifyDesktopName 调用ModifyDesktopName修改一台云桌面的桌面名称。
ModifyEntitlement 调用ModifyEntitlement为桌面重新分配用户。
RenewDesktops 调用RenewDesktops续费一台或者多台包年包月云桌面。
DeleteDesktops 调用DeleteDesktops释放一台或多台云桌面。

工作区

API 描述
CreateSimpleOfficeSite 调用CreateSimpleOfficeSite创建一个便捷账号的工作区。
CreateADConnectorOfficeSite 调用CreateADConnectorOfficeSite创建一个企业AD账号的工作区。
ModifyADConnectorOfficeSite 调用ModifyADConnectorOfficeSite修改AD工作区。
ModifyOfficeSiteCrossDesktopAccess 调用ModifyOfficeSiteCrossDesktopAccess开启工作区内桌面互通。
ModifyOfficeSiteAttribute 调用ModifyOfficeSiteAttribute修改工作区的属性。
ModifyOfficeSiteMfaEnabled 调用ModifyOfficeSiteMfaEnabled为工作区开启或者关闭多因素认证MFA功能。
ListOfficeSiteOverview 调用ListOfficeSiteOverview查询工作区的概览信息。
DescribeOfficeSites 调用DescribeOfficeSites查询工作区的详细信息。
DeleteOfficeSites 调用DeleteOfficeSites销毁工作区。

AD用户

API 描述
ListOfficeSiteUsers 调用ListOfficeSiteUsers查询AD工作区对接企业AD后获取的AD用户信息。
DescribeVirtualMFADevices 调用DescribeVirtualMFADevices查询AD用户绑定的虚拟MFA设备。
LockVirtualMFADevice 调用LockVirtualMFADevice锁定处于正常(NORMAL)状态的虚拟MFA设备。
UnlockVirtualMFADevice 调用UnlockVirtualMFADevice解锁处于锁定(LOCKED)状态的虚拟MFA设备。
DeleteVirtualMFADevice 调用DeleteVirtualMFADevice删除虚拟MFA设备。

便捷用户

API 描述
CreateUsers 调用CreateUsers创建一个或者多个便捷用户。
DescribeUsers 调用DescribeUsers查询便捷用户信息。
LockUsers 调用LockUsers锁定一个或者多个便捷用户。
UnlockUsers 调用UnlockUsers解锁一个或者多个便捷用户。
ResetUserPassword 调用ResetUserPassword重置便捷用户的密码,包括生成重置密码Token,并发送重置密码邮件到便捷用户的邮箱。
RemoveUsers 调用RemoveUsers删除一个或者多个便捷用户。

策略

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

镜像

API 描述
CreateImage 调用CreateImage创建自定义镜像。
DescribeImages 调用DescribeImages查询镜像的详细信息。
ModifyImageAttribute 调用ModifyImageAttribute修改镜像属性。
DeleteImages 调用DeleteImages删除一个或多个自定义镜像。

桌面模板

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

网络

API 描述
CreateNetworkPackage 调用CreateNetworkPackage创建一个互联网访问包,为工作区开通互联网访问功能。
DescribeNetworkPackages 调用DescribeNetworkPackages查询一个或者多个互联网访问包的详细信息。
ModifyNetworkPackage 调用ModifyNetworkPackage修改互联网访问包包含的公网带宽峰值。
DeleteNetworkPackages 调用DeleteNetworkPackages删除一个或者多个互联网访问包,即关闭互联网访问功能。
AttachCen 调用AttachCen将工作区网络加入到云企业网实例中。
DetachCen 调用DetachCen将工作区网络与云企业网实例解绑。
DescribeCens 调用DescribeCens查询账号下所有云企业网实例信息。

存储

API 描述
CreateNASFileSystem 调用CreateNASFileSystem创建一个NAS文件系统。
DescribeNASFileSystems 调用DescribeNASFileSystems查询NAS文件系统信息。
ModifyNASDefaultMountTarget 调用ModifyNASDefaultMountTarget修改NAS文件系统的挂载点。
ResetNASDefaultMountTarget 调用ResetNASDefaultMountTarget重置NAS文件系统的挂载点。
DeleteNASFileSystems 调用DeleteNASFileSystems删除一个或者多个NAS文件系统。

快照

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

安全

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

地域

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

审计

API 描述
DescribeClientEvents 调用DescribeClientEvents查询终端用户的操作日志。

云助手

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

标签

API 描述
TagResources 调用TagResources为指定的资源创建并绑定标签。
ListTagResources 调用ListTagResources查询指定资源已绑定的标签列表。
UntagResources 调用UntagResources为指定的云桌面解绑标签。

SSO设置

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