办公网络(原工作区)
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 名称 | 描述 | 操作 |
---|---|---|
云电脑资源 | ||
CreateDesktops![]() | 创建一台或多台云电脑。创建时若传入用户信息,可直接完成云电脑的分配 | 查看文档去调试 |
CreateDiskEncryptionService | 开启磁盘加密功能,在用户RAM下添加企业网盘加密的服务关联角色(SLR) | 查看文档去调试 |
DescribeKmsKeys | 查询用户KMS密钥列表。如果是第一次访问,将尝试创建一个EDS的服务密钥,并返回结果 | 查看文档去调试 |
DescribeDesktopInfo![]() | 查询云电脑的基础信息 | 查看文档去调试 |
DescribeDesktops![]() | 查询云电脑的详细信息 | 查看文档去调试 |
DescribeDesktopTypes![]() | 查询云电脑规格的详细信息 | 查看文档去调试 |
DescribeCustomizedListHeaders | 获取云电脑列表页的表头信息 | 查看文档去调试 |
StartDesktops | 启动一台或者多台已停止的云电脑。接口调用成功后,云电脑进入运行中状态 | 查看文档去调试 |
StopDesktops | 停止一台或者多台运行中的云电脑。接口调用成功后,云电脑进入已停止状态 | 查看文档去调试 |
SetDesktopMaintenance | 设置云电脑维护模式 | 查看文档去调试 |
ModifyDesktopName | 将指定云电脑的名称修改为新名称 | 查看文档去调试 |
ModifyDiskSpec | 修改云电脑系统盘或数据盘的磁盘性能等级 | 查看文档去调试 |
ModifyDesktopChargeType | 将云电脑的付费类型转为包年包月或按量付费 | 查看文档去调试 |
ModifyDesktopSpec | 变更云电脑的规格和扩容磁盘 | 查看文档去调试 |
ModifyDesktopTimer | 创建或修改云电脑定时任务,例如定时开机、关机、重启、重置等 | 查看文档去调试 |
ModifyDesktopHostName | 修改AD办公网络下的Windows云电脑的主机名称 | 查看文档去调试 |
ModifyCustomizedListHeaders | 修改云电脑列表页表头的显示类型(包括必选、显示和隐藏) | 查看文档去调试 |
DeleteDesktops![]() | 释放一台或多台按量付费云电脑或到期的包年包月云电脑 | 查看文档去调试 |
ExportDesktopListInfo | 将云电脑列表导出为CSV文件 | 查看文档去调试 |
HibernateDesktops | 对云电脑执行休眠操作 | 查看文档去调试 |
WakeupDesktops | 对云电脑执行唤醒操作 | 查看文档去调试 |
RebootDesktops | 重启一台或者多台云电脑 | 查看文档去调试 |
RebuildDesktops![]() | 为一台或多台云电脑变更镜像 | 查看文档去调试 |
MigrateDesktops | 将云电脑从当前所属办公网络(原工作区)迁移到新的办公网络 | 查看文档去调试 |
RenewDesktops | 续费一台或者多台按月购买云电脑 | 查看文档去调试 |
云电脑授权用户 | ||
DescribeUsersPassword | 查询云电脑镜像内账号的密码。例如,在云电脑上的Chrome浏览器查询缓存的密码时,会要求终端用户输入该密码进行验证 | 查看文档去调试 |
GetConnectionTicket![]() | 获取云电脑连接凭证 | 查看文档去调试 |
DescribeGuestApplications | 查询云电脑指定授权用户的应用和进程信息 | 查看文档去调试 |
ModifyUserEntitlement | 为一个或多个用户新增或删除指定的一台或多台云电脑的授权 | 查看文档去调试 |
ModifyEntitlement![]() | 将云电脑分配给指定用户,同时移除该云电脑此前已有的所有授权用户 | 查看文档去调试 |
共享型云电脑
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 名称 | 描述 | 操作 |
---|---|---|
企业网盘(原无影云盘) | ||
网盘 | ||
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 名称 | 描述 | 操作 |
---|---|---|
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 | 查询指定配置组的详细信息 | 查看文档去调试 |
监控运维
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
DescribeDesktopSessions | 查询云电脑的详细会话信息 | 查看文档去调试 |
DescribeDesktopGroupSessions | 查询共享型云电脑会话监控详情 | 查看文档去调试 |
DescribeSessionStatistic | 查询全地域的会话统计信息 | 查看文档去调试 |
GetCoordinateTicket | 获取协同流凭证,用于进行远程协助或共享协同 | 查看文档去调试 |
DisconnectDesktopSessions | 断开云电脑会话 | 查看文档去调试 |
ApplyCoordinationForMonitoring | 管理员向终端用户发起远程协助请求。主要用于管理员协助场景和教育场景 | 查看文档去调试 |
CancelCoordinationForMonitoring | 取消向终端用户发起的远程协助请求 | 查看文档去调试 |
ApplyCoordinatePrivilege | 申请流协同操作权限 | 查看文档去调试 |
RevokeCoordinatePrivilege | 取消流协同操作权限 | 查看文档去调试 |