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

桌面

API 描述
CreateDesktops 调用CreateDesktops创建一台或多台云桌面。
DescribeDesktops 调用DescribeDesktops查询云桌面的详细信息。
DescribeDesktopTypes 调用DescribeDesktopTypes查询云桌面的规格详细信息。
RebootDesktops 调用RebootDesktops重启云桌面。
StartDesktops 调用StartDesktops启动一台或者多台已停止的云桌面。
StopDesktops 调用StopDesktops停止一台或者多台运行中的云桌面。
ModifyDesktopName 调用ModifyDesktopName修改一台云桌面的桌面名称。
RenewDesktops 调用RenewDesktops续费一台或者多台包年包月云桌面。
DeleteDesktops 调用DeleteDesktops释放一台或多台云桌面。

目录

API 描述
CreateRAMDirectory 调用CreateRAMDirectory创建RAM类型的目录。
CreateADConnectorDirectory 调用CreateADConnectorDirectory创建AD类型的目录。
ModifyADConnectorDirectory 调用ModifyADConnectorDirectory修改AD目录。
DescribeDirectories 调用DescribeDirectories查询目录的详细信息。
DeleteDirectories 调用DeleteDirectories删除一个或多个目录。

用户

API 描述
ListDirectoryUsers 调用ListDirectoryUsers查询AD目录对应的用户信息。
ModifyEntitlement 调用ModifyEntitlement为桌面重新分配用户。

快照

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

策略

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

镜像

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

桌面模板

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

地域

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

审计

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

云助手

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

标签

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

MFA设备

API 描述
DescribeVirtualMFADevices 调用DescribeVirtualMFADevices查询AD用户绑定的虚拟MFA设备。
LockVirtualMFADevice 调用LockVirtualMFADevice锁定处于正常(NORMAL)状态的虚拟MFA设备。
UnlockVirtualMFADevice 调用UnlockVirtualMFADevice解锁处于锁定(LOCKED)状态的虚拟MFA设备。
DeleteVirtualMFADevice 调用DeleteVirtualMFADevice删除虚拟MFA设备。

SSO设置

API 描述
SetDirectorySsoStatus 调用SetDirectorySsoStatus设置AD目录的SSO状态。
GetDirectorySsoStatus 调用GetDirectorySsoStatus获取AD目录的SSO状态。
GetSpMetadata 调用GetSpMetadata获取基于SAML 2.0的服务提供商SP的元数据。
SetIdpMetadata 调用SetIdpMetadata上传基于SAML 2.0的身份提供商IdP的元数据。