阿里云OpenAPI开发者门户

无影云电脑 - OpenAPI 概览2020-09-30
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
地域
OpenAPI 名称描述操作
DescribeRegionshot查询无影云桌面支持的阿里云地域信息查看文档去调试
DescribeZones查询无影云电脑在某一个阿里云地域下支持的可用区信息查看文档去调试
询价
OpenAPI 名称描述操作
DescribeRenewalPrice查询无影商品的续费价格查看文档去调试
DescribeModificationPrice查询按月购买不限时长云电脑或公网精品带宽的变配价格查看文档去调试
DescribeRefundPrice查询按月购买云电脑的退订价格查看文档去调试
DescribePrice查询无影商品的新购价格查看文档去调试
办公网络(原工作区)
OpenAPI 名称描述操作
办公网络通用
ListOfficeSiteOverview查询办公网络(原工作区)的概览信息,包括状态、云电脑数量、VPC网络类型等查看文档去调试
DescribeOfficeSites查询办公网络的所有属性,包括ID、名称、状态、创建时间等查看文档去调试
ModifyOfficeSiteAttribute修改办公网络(原工作区)的基本属性,例如办公网络名称、是否为使用云电脑的用户赋予本地管理员权限等查看文档去调试
ModifyOfficeSiteCrossDesktopAccess开启或关闭办公网络(原工作区)内云电脑互通。开启后,同一个办公网络内的云电脑之间可以实现相互访问彼此的网络查看文档去调试
DeleteOfficeSites将办公网络(原工作区)内的云电脑资源完全释放后可以将办公网络删除查看文档去调试
ModifyOfficeSiteDnsInfo修改办公网络DNS信息查看文档去调试
基于便捷账号的办公网络
CreateSimpleOfficeSite无影云电脑支持便捷账号和企业AD账号这两种账号体系。本接口用于创建一个基于便捷账号的办公网络(原工作区)查看文档去调试
ActivateOfficeSite基于便捷账号的办公网络闲置一定时间后将被自动锁定。调用本接口可解锁查看文档去调试
基于企业AD账号的办公网络
CreateADConnectorOfficeSite无影云电脑支持便捷账号和企业AD账号这两种账号体系。本接口用于创建一个基于企业AD账号的办公网络(原工作区)查看文档去调试
ListUserAdOrganizationUnits获取AD办公网络(原工作区)对接的AD域的组织单元OU信息查看文档去调试
ListOfficeSiteUsers查询AD办公网络(原工作区)对接AD域后获取的AD账号信息查看文档去调试
ModifyADConnectorOfficeSite修改AD办公网络(原工作区)的基本属性,例如办公网络名称、企业AD子域的域名等查看文档去调试
ModifyOfficeSiteMfaEnabled为AD办公网络(原工作区)开启或者关闭多因素认证MFA查看文档去调试
ConfigADConnectorTrust对于采用HDX协议的办公网络(原工作区),需要配置条件转发器和信任关系后方可正常使用。可调用本接口为AD办公网络配置信任关系查看文档去调试
ConfigADConnectorUser为AD办公网络(原工作区)指定组织单元OU和管理员查看文档去调试
目录
OpenAPI 名称描述操作
CreateADConnectorDirectory创建AD类型的目录查看文档去调试
CreateRAMDirectory创建RAM类型的目录查看文档去调试
DescribeDirectories查询目录的详细信息查看文档去调试
ListDirectoryUsers如果您使用AD目录来对接企业自有AD,调用该接口可以获取企业AD中的用户信息查看文档去调试
ModifyADConnectorDirectory修改AD目录查看文档去调试
DeleteDirectories删除一个或多个目录查看文档去调试
云电脑
OpenAPI 名称描述操作
云电脑资源
CreateDesktopshot创建一台或多台云电脑。创建时若传入用户信息,可直接完成云电脑的分配查看文档去调试
CreateDiskEncryptionService开启磁盘加密功能,在用户RAM下添加企业网盘加密的服务关联角色(SLR)查看文档去调试
DescribeKmsKeys查询用户KMS密钥列表。如果是第一次访问,将尝试创建一个EDS的服务密钥,并返回结果查看文档去调试
DescribeDesktopInfohot查询云电脑的基础信息查看文档去调试
DescribeDesktopshot查询云电脑的详细信息查看文档去调试
DescribeDesktopTypeshot查询云电脑规格的详细信息查看文档去调试
DescribeCustomizedListHeaders获取云电脑列表页的表头信息查看文档去调试
StartDesktops启动一台或者多台已停止的云电脑。接口调用成功后,云电脑进入运行中状态查看文档去调试
StopDesktops停止一台或者多台运行中的云电脑。接口调用成功后,云电脑进入已停止状态查看文档去调试
SetDesktopMaintenance设置云电脑维护模式查看文档去调试
ModifyDesktopName将指定云电脑的名称修改为新名称查看文档去调试
ModifyDiskSpec修改云电脑系统盘或数据盘的磁盘性能等级查看文档去调试
ModifyDesktopChargeType将云电脑的付费类型转为包年包月或按量付费查看文档去调试
ModifyDesktopSpec变更云电脑的规格和扩容磁盘查看文档去调试
ModifyDesktopTimer创建或修改云电脑定时任务,例如定时开机、关机、重启、重置等查看文档去调试
ModifyDesktopHostName修改AD办公网络下的Windows云电脑的主机名称查看文档去调试
ModifyCustomizedListHeaders修改云电脑列表页表头的显示类型(包括必选、显示和隐藏)查看文档去调试
DeleteDesktopshot释放一台或多台按量付费云电脑或到期的包年包月云电脑查看文档去调试
ExportDesktopListInfo将云电脑列表导出为CSV文件查看文档去调试
HibernateDesktops对云电脑执行休眠操作查看文档去调试
WakeupDesktops对云电脑执行唤醒操作查看文档去调试
RebootDesktops重启一台或者多台云电脑查看文档去调试
RebuildDesktopshot为一台或多台云电脑变更镜像查看文档去调试
MigrateDesktops将云电脑从当前所属办公网络(原工作区)迁移到新的办公网络查看文档去调试
RenewDesktops续费一台或者多台按月购买云电脑查看文档去调试
云电脑授权用户
DescribeUsersPassword查询云电脑镜像内账号的密码。例如,在云电脑上的Chrome浏览器查询缓存的密码时,会要求终端用户输入该密码进行验证查看文档去调试
GetConnectionTickethot获取云电脑连接凭证查看文档去调试
DescribeGuestApplications查询云电脑指定授权用户的应用和进程信息查看文档去调试
ModifyUserEntitlement为一个或多个用户新增或删除指定的一台或多台云电脑的授权查看文档去调试
ModifyEntitlementhot将云电脑分配给指定用户,同时移除该云电脑此前已有的所有授权用户查看文档去调试
共享型云电脑
OpenAPI 名称描述操作
共享型云电脑资源
CreateDesktopGroup创建共享型云电脑查看文档去调试
GetDesktopGroupDetail获取一个共享型云电脑的详细信息查看文档去调试
DescribeDesktopGroups查询共享型云电脑列表及详情查看文档去调试
DescribeDesktopsInGroup按付费类型查询共享型云电脑包含的云电脑列表查看文档去调试
DisableDesktopsInGroup禁用共享型云电脑中的云电脑。禁用后,云电脑的状态变为unavailable查看文档去调试
ModifyDesktopGroup修改共享型云电脑查看文档去调试
SetDesktopGroupScaleTimer为多会话云电脑设置自动扩缩策略。多会话云电脑允许多个用户同时连接同一台云电脑,可节省成本查看文档去调试
SetDesktopGroupTimer设置共享型云电脑定时任务,执行定时开机、关机、重启或重置任务查看文档去调试
SetDesktopGroupTimerStatus设置共享型云电脑定时任务的状态,例如将定时任务设为启用或禁用查看文档去调试
DeleteDesktopGroup释放共享型云电脑查看文档去调试
ExportDesktopGroupInfo调用本接口导出的共享型云电脑列表将保存为XLSX文件。每条共享型云电脑数据包括共享型云电脑ID和名称、办公网络ID和名称、共享型云电脑模板、安全策略名称等查看文档去调试
ResetDesktops重置共享型云电脑内的云电脑查看文档去调试
RenewDesktopGroup为包年包月共享型云电脑续费查看文档去调试
共享型云电脑用户
AddUserToDesktopGroup为共享型云电脑添加授权用户。共享型云电脑内的云电脑会按照管理员设置的规则自动分配给授权用户使用查看文档去调试
DescribeUsersInGroup查询共享型云电脑所有授权用户的详情,包括用户名、邮箱地址、手机号、获得授权的云电脑ID等查看文档去调试
DescribeUserConnectionRecords查询云电脑池的授权用户连接池化云电脑的具体记录查看文档去调试
ModifyUserToDesktopGroup将共享型云电脑的指定授权用户替换为其他指定授权用户查看文档去调试
RemoveUserFromDesktopGroup将共享型云电脑的指定授权用户移除出去。被移除的用户将无法再连接共享型云电脑内的云电脑查看文档去调试
公网精品带宽
OpenAPI 名称描述操作
CreateNetworkPackage为办公网络创建一个公网精品带宽查看文档去调试
DescribeNetworkPackages查询一个或者多个公网精品带宽的详细信息查看文档去调试
DescribeFlowMetric查询云电脑的流入带宽和流出带宽,或是公网精品带宽的公网访问流入带宽和流出带宽监控数据查看文档去调试
DescribeFlowStatistic获取单一办公网络下云电脑粒度的流量统计数据查看文档去调试
DescribeAclEntries查询办公网络或云电脑粒度上的公网访问控制策略详情查看文档去调试
ModifyAclEntries修改办公网络或云电脑粒度上的公网访问控制策略查看文档去调试
ModifyNetworkPackageBandwidth修改公网精品带宽的带宽大小查看文档去调试
ModifyNetworkPackageEnabled恢复或停用公网精品带宽查看文档去调试
DeleteNetworkPackages删除一个或者多个公网精品带宽查看文档去调试
AssociateNetworkPackage将公网精品带宽绑定至办公网络。公网精品带宽和办公网络是一对一的绑定关系查看文档去调试
DissociateNetworkPackage将公网精品带宽与此前绑定的办公网络解绑查看文档去调试
RenewNetworkPackages为包年包月公网精品带宽续费查看文档去调试
云企业网
OpenAPI 名称描述操作
DescribeCens查询账号下所有云企业网实例信息查看文档去调试
AttachCen将高级办公网络与云企业网实例绑定查看文档去调试
DetachCen将高级办公网络与已加入的云企业网实例解绑查看文档去调试
VerifyCen校验云企业网实例ID与所属阿里云账号ID是否正确,以及实例路由与办公网络IPv4网段是否存在网段冲突查看文档去调试
SendVerifyCode将高级办公网络加入其他阿里云账号下的云企业网实例时,需要调用此接口获取验证码查看文档去调试
存储
OpenAPI 名称描述操作
企业网盘(原无影云盘)
网盘
CreateCloudDriveService创建企业网盘(原无影云盘)查看文档去调试
团队共享盘
DescribeCloudDriveGroups查询企业网盘内所有团队共享盘的列表及基本信息查看文档去调试
ModifyCloudDriveGroups修改团队共享盘的基本属性,例如共享盘的状态、存储峰值等查看文档去调试
DeleteCloudDriveGroups删除团队共享盘查看文档去调试
用户个人盘
CreateCloudDriveUsers在企业网盘中添加用户个人盘查看文档去调试
DescribeCloudDriveUsers查询企业网盘内所有用户个人盘的列表及基本信息查看文档去调试
ModifyCloudDriveUsers修改用户个人盘的基本属性,例如个人盘的状态、存储峰值等查看文档去调试
DeleteCloudDriveUsers删除企业网盘内的用户个人盘查看文档去调试
权限
DescribeCloudDrivePermissions查询企业网盘的权限设置详情查看文档去调试
ModifyCloudDrivePermission企业网盘的默认策略是所有用户均可从本地设备上传文件至企业网盘,但不可从企业网盘下载文件至本地设备。调用本接口可添加具备例外权限的用户查看文档去调试
文件管理
CreateCdsFile在网盘中创建文件夹或者创建文件上传任务查看文档去调试
ListCdsFiles查询网盘中的文件列表,以及获取文件的下载链接查看文档去调试
GetAsyncTask根据CopyCdsFile接口获得的AsyncTaskId返回参数获取文件夹复制异步任务的详细信息查看文档去调试
ModifyCdsFile修改网盘文件或文件夹的属性,例如文件名查看文档去调试
DeleteCdsFile删除网盘中的文件或文件夹查看文档去调试
CompleteCdsFile创建文件上传任务后,调用本接口完成上传动作查看文档去调试
CopyCdsFile为网盘中的文件或文件夹制作一个副本查看文档去调试
MoveCdsFile将网盘中的文件或文件夹移动至新的位置查看文档去调试
DownloadCdsFile获取目标文件的下载链接查看文档去调试
文件分享
CreateCdsFileShareLink创建文件分享查看文档去调试
DescribeCdsFileShareLinks查询文件分享查看文档去调试
ModifyCdsFileShareLink修改文件分享的设置查看文档去调试
CancelCdsFileShareLink取消文件分享查看文档去调试
文件夹共享
AddFilePermission在网盘内新增共享的文件夹查看文档去调试
ListFilePermission查询网盘中的共享文件夹的权限信息查看文档去调试
RemoveFilePermission将网盘内的文件夹取消共享查看文档去调试
共享存储NAS
CreateAndBindNasFileSystem创建NAS文件系统并且绑定到共享型云电脑的办公网络查看文档去调试
CreateNASFileSystem创建一个NAS文件系统查看文档去调试
DescribeNASFileSystems查询NAS文件系统信息查看文档去调试
ModifyNASDefaultMountTarget修改NAS文件系统的挂载点查看文档去调试
ResetNASDefaultMountTarget重置NAS文件系统的挂载点查看文档去调试
DeleteNASFileSystems删除一个或者多个NAS文件系统查看文档去调试
模板
OpenAPI 名称描述操作
CreateBundle创建自定义的云电脑模板查看文档去调试
DescribeBundles查询云电脑模板的详细信息查看文档去调试
ModifyBundle修改自定义云电脑模板查看文档去调试
DeleteBundles删除一个或多个自定义云电脑模板查看文档去调试
镜像
OpenAPI 名称描述操作
CreateImage通过已部署好的云电脑创建自定义镜像,以便快速创建更多相同配置的云电脑,避免每次创建时重复配置查看文档去调试
DescribeImages查询镜像的详细信息查看文档去调试
DescribeImageModifiedRecords查询云电脑的镜像变更记录查看文档去调试
DescribeImagePermission获取当前镜像已共享的阿里云账号列表查看文档去调试
ModifyImageAttribute修改镜像的属性,包括镜像的名称和描述查看文档去调试
ModifyImagePermission将镜像共享给无影的其他用户或者取消已经共享的镜像查看文档去调试
DeleteImages删除一个或多个自定义镜像查看文档去调试
CopyImage将镜像复制到另一地域。如需跨地域分享镜像,可以先调用本接口将镜像复制到新地域再进行分享查看文档去调试
UploadImage上传用户的自定义Windows镜像查看文档去调试
MigrateImageProtocol将镜像的协议升级为ASP协议查看文档去调试
CancelCopyImage取消将镜像复制至另一地域的操作查看文档去调试
快照
OpenAPI 名称描述操作
快照管理
CreateSnapshot为云电脑的磁盘创建一份快照,用于备份和恢复磁盘上的数据查看文档去调试
DescribeSnapshots查询一台云电脑的快照列表和快照的详细信息查看文档去调试
ResetSnapshot恢复快照对应的磁盘数据查看文档去调试
DeleteSnapshot用于删除一份或多份快照查看文档去调试
自动快照策略
CreateAutoSnapshotPolicy创建自动快照策略,让云电脑按照Cron表达式对应的时间自动创建快照查看文档去调试
DescribeAutoSnapshotPolicy查询自动快照策略查看文档去调试
ApplyAutoSnapshotPolicy为云电脑绑定自动快照策略。绑定后,云电脑将按照自动快照策略规定的时间自动创建快照查看文档去调试
ModifyAutoSnapshotPolicy修改自动快照策略的配置项,包括策略名称、快照保留时间等查看文档去调试
CancelAutoSnapshotPolicy取消云电脑的自动快照策略查看文档去调试
DeleteAutoSnapshotPolicy删除自动快照策略查看文档去调试
策略
OpenAPI 名称描述操作
无地域策略
DeleteCenterPolicy删除一条无地域策略查看文档去调试
ModifyResourceCenterPolicy修改与云资源绑定的无地域策略查看文档去调试
ModifyCenterPolicy修改一条无地域策略的配置查看文档去调试
DescribeResourceByCenterPolicyId查询无地域策略绑定的云资源查看文档去调试
DescribeCenterPolicyList查询无地域策略的详细信息查看文档去调试
CreateCenterPolicy创建一条无地域的云电脑策略查看文档去调试
CloneCenterPolicy基于现有无地域策略克隆出一个策略查看文档去调试
CreatePolicyGroup创建云电脑策略查看文档去调试
DescribePolicyGroups查询云电脑策略的详细信息查看文档去调试
ModifyPolicyGroup修改云电脑策略查看文档去调试
ModifyDesktopsPolicyGroup为云电脑更换绑定的云电脑策略查看文档去调试
DeletePolicyGroups删除一个或多个自定义云电脑策略查看文档去调试
ClonePolicyGroup通过克隆云电脑策略来实现快速创建自定义云电脑策略的目的查看文档去调试
配置组
OpenAPI 名称描述操作
CreateConfigGroup创建配置组。配置组中包含云电脑中心定时任务的配置信息查看文档去调试
ModifyConfigGroup修改配置组的基本信息,包括名称和描述查看文档去调试
DeleteConfigGroup删除配置组查看文档去调试
BindConfigGroup将配置组与云电脑或资源组绑定查看文档去调试
UnbindConfigGroup将绑定在资源上的配置组解绑查看文档去调试
DescribeConfigGroup查询配置组列表信息查看文档去调试
ModifyTimerGroup修改配置组的具体设置,例如定时任务的配置查看文档去调试
DescribeTimerGroup查询指定配置组的详细信息查看文档去调试
MFA
OpenAPI 名称描述操作
DescribeVirtualMFADevices查询AD账号绑定的虚拟MFA设备查看文档去调试
DeleteVirtualMFADevice删除AD账号绑定的虚拟MFA设备查看文档去调试
UnlockVirtualMFADevice解锁处于锁定(LOCKED)状态的虚拟MFA设备查看文档去调试
LockVirtualMFADevice锁定处于正常(NORMAL)状态的虚拟MFA设备查看文档去调试
镜像升级OTA
OpenAPI 名称描述操作
DescribeFotaTasks获取镜像升级任务列表查看文档去调试
DescribeFotaPendingDesktops获取可升级到指定版本镜像但尚未升级的云电脑信息查看文档去调试
UpdateFotaTask为镜像升级任务打开或关闭自动推送查看文档去调试
ApproveFotaUpdate允许升级镜像查看文档去调试
SSO设置
OpenAPI 名称描述操作
GetOfficeSiteSsoStatus查询办公网络是否开启了单点登录SSO功能查看文档去调试
GetSpMetadata获取基于SAML 2.0的服务提供商SP(Service Provider)的元数据查看文档去调试
SetOfficeSiteSsoStatus为办公网络开启或关闭单点登录SSO功能查看文档去调试
SetIdpMetadata上传基于SAML 2.0的身份提供商IdP(Identity Provider)的元数据查看文档去调试
SetDirectorySsoStatus为基于AD账号的办公网络开启或关闭单点登录SSO功能查看文档去调试
云助手
OpenAPI 名称描述操作
DescribeInvocations用于查询云助手脚本的执行列表和状态查看文档去调试
StopInvocation停止一台或多台云电脑中的一条执行中云助手脚本的进程查看文档去调试
RunCommandhot在一台或多台Windows操作系统的云电脑中执行一段PowerShell或者Bat类型的脚本查看文档去调试
标签
OpenAPI 名称描述操作
ListTagResources查询云电脑已添加标签的列表查看文档去调试
TagResources为指定的云电脑添加标签,方便通过标签统一筛选和管理云电脑查看文档去调试
UntagResources为云电脑移除标签。移除标签后,如果该标签没有被添加到任何云电脑上,则标签会被自动删除查看文档去调试
审计
OpenAPI 名称描述操作
DescribeClientEvents查询终端用户的操作日志,包括云电脑的开机、关机、会话断开等事件查看文档去调试
DescribeRecordings查询录屏文件的详细信息查看文档去调试
ExportClientEvents导出客户端事件列表查看文档去调试
终端管理
OpenAPI 名称描述操作
AddDevices添加可信设备查看文档去调试
DescribeDevices查询可信设备列表查看文档去调试
AttachEndUser如果希望硬件终端只能被指定的终端用户登录,您需要开启可信设备认证功能,并为硬件终端添加绑定用户查看文档去调试
DetachEndUser为无影硬件终端移除绑定用户查看文档去调试
DeleteDevices删除可信设备查看文档去调试
监控运维
OpenAPI 名称描述操作
DescribeDesktopSessions查询云电脑的详细会话信息查看文档去调试
DescribeDesktopGroupSessions查询共享型云电脑会话监控详情查看文档去调试
DescribeSessionStatistic查询全地域的会话统计信息查看文档去调试
GetCoordinateTicket获取协同流凭证,用于进行远程协助或共享协同查看文档去调试
DisconnectDesktopSessions断开云电脑会话查看文档去调试
ApplyCoordinationForMonitoring管理员向终端用户发起远程协助请求。主要用于管理员协助场景和教育场景查看文档去调试
CancelCoordinationForMonitoring取消向终端用户发起的远程协助请求查看文档去调试
ApplyCoordinatePrivilege申请流协同操作权限查看文档去调试
RevokeCoordinatePrivilege取消流协同操作权限查看文档去调试
流量包
OpenAPI 名称描述操作
CreateBandwidthResourcePackages创建无影流量包查看文档去调试