文档首页/ 云桌面 Workspace/ CLI参考/ CLI命令参考(云桌面)
更新时间:2026-09-09 GMT+08:00

CLI命令参考(云桌面)

租户配置

API名称

命令

描述

操作

查询租户功能状态

hcloud Workspace ListTenantProfiles

查询租户功能状态。

去调试

启禁用租户功能

hcloud Workspace UpdateTenantProfile

启禁用租户功能。

去调试

获取云办公服务接入地址备份配置

hcloud Workspace ListAccessAddressBackupConfig

该接口用于获取云办公服务接入地址备份配置。

去调试

修改云办公服务接入地址备份配置

hcloud Workspace UpdateAccessAddressBackupConfig

该接口用于修改云办公服务接入地址备份配置。

去调试

查询认证登录方式

hcloud Workspace ShowAuthConfig

查询认证登录方式配置信息。

去调试

更新认证策略配置

hcloud Workspace UpdateAuthMethodConfig

更新认证策略配置信息。

去调试

查询辅助认证配置

hcloud Workspace ShowAssistAuthConfig

查询辅助认证的配置信息。

去调试

更新辅助认证策略配置

hcloud Workspace UpdateAssistAuthMethodConfig

更新辅助认证策略配置。

去调试

查询辅助认证应用对象列表

hcloud Workspace ShowAssistAuthConfigApplyObjects

查询辅助认证应用对象列表。

去调试

更新辅助认证应用对象列表

hcloud Workspace UpdateAssistAuthConfigApplyObjects

更新辅助认证应用对象列表。

去调试

下载SAML 2.0元数据信息

hcloud Workspace DownloadMetadata

下载SAML 2.0元数据信息。

去调试

下载SAML 2.0 SP元数据信息

hcloud Workspace DownloadSpMetadata

下载SAML 2.0 SP元数据信息。

去调试

校验配置是否合法(当前仅支持SAML2配置校验)

hcloud Workspace ValidateConfig

校验配置是否合法(当前仅支持SAML2配置校验)。

去调试

增量更新认证配置

hcloud Workspace UpdateAuthConfig

增量更新指定认证配置。

去调试

查询租户个性配置列表

hcloud Workspace ListTenantConfigs

查询租户个性配置列表。

去调试

修改租户个性配置

hcloud Workspace UpdateTenantConfig

租户个性配置修改。

去调试

查询协同桌面默认用户配置

hcloud Workspace ShowShareSpaceConfig

查询协同桌面默认用户配置(当前功能公测中,需要使用请联系管理员申请使用)。

去调试

设置协同桌面默认用户配置

hcloud Workspace UpdateShareSpaceConfig

设置协同桌面默认用户配置(当前功能公测中,需要使用请联系管理员申请使用)。

去调试

查询租户的NAT映射配置项

hcloud Workspace ListNatMappingConfigs

查询租户的NAT映射配置项。

去调试

修改租户的NAT映射配置项

hcloud Workspace UpdateNatMappingConfigs

修改租户的NAT映射配置项。

去调试

云办公服务

API名称

命令

描述

操作

查询站点信息

hcloud Workspace ListSiteConfigs

用于查询站点信息的接口。

去调试

新增站点

hcloud Workspace AddSite

新增站点信息的接口。

去调试

删除站点

hcloud Workspace DeleteSite

用于删除站点的接口。

去调试

重置站点认证信息

hcloud Workspace ResetSiteAuthConfig

重置站点认证信息。

去调试

修改站点专线自助维护通道

hcloud Workspace UpdateDcVnc

用于更新站点属性的接口。

去调试

修改站点接入方式

hcloud Workspace UpdateAccessMode

用于修改站点接入方式。

去调试

修改站点业务子网

hcloud Workspace UpdateSubnetIds

用于修改站点业务子网。

去调试

查询边缘小站列表

hcloud Workspace ListWksEdgeSites

查询边缘小站列表。

去调试

校验边缘站点资源

hcloud Workspace CheckEdgeSiteResources

校验边缘站点资源。

去调试

查询域控的配置信息

hcloud Workspace ShowDomainsNew

查询域控的配置信息。

去调试

配置域控

hcloud Workspace CreateDomainNew

配置域控。

去调试

修改域控

hcloud Workspace UpdateDomainNew

修改域控。

去调试

关闭域控的配置信息

hcloud Workspace CloseDomainNew

关闭域控的配置信息。暂不支持关闭AD域控。

去调试

同步域控用户(组)

hcloud Workspace SyncExternalUser

同步域控用户(组)。

去调试

查询云办公服务详情

hcloud Workspace ListWorkspaces

该接口用于查询云办公服务详情。

去调试

开通云办公服务

hcloud Workspace ApplyWorkspace

该接口用于开通云办公服务。

去调试

修改云办公服务属性

hcloud Workspace UpdateWorkspace

该接口目前支持修改云办公服务属性。单次请求仅支持修改一种属性类型。

去调试

注销云办公服务

hcloud Workspace CancelWorkspace

该接口用于注销云办公服务。注销前请确保当前用户下的云桌面已经删除,注销后无法恢复。

去调试

检查企业ID是否已被使用

hcloud Workspace CheckEnterpriseId

检查企业ID是否已被使用。

去调试

修改企业ID

hcloud Workspace UpdateEnterpriseId

修改租户的企业ID。

去调试

查询云办公服务是否被锁定

hcloud Workspace ShowWorkspaceLock

查询云办公服务是否被锁定。

去调试

解除云办公服务锁定状态

hcloud Workspace UnlockWorkspace

该接口目前支持解除云办公服务锁定状态。

去调试

校验域控有效性

hcloud Workspace ValidateDomainController

校验域控有效性。

去调试

证书管理

API名称

命令

描述

操作

查询CA证书列表

hcloud Workspace ListCerts

查询CA证书列表。

去调试

创建证书

hcloud Workspace CreateCert

创建证书。

去调试

查询ca证书详情

hcloud Workspace ShowCertDetail

查询ca证书详情。

去调试

删除ca证书

hcloud Workspace DeleteCert

删除ca证书。

去调试

启用或禁用ca证书

hcloud Workspace SetCertStatus

启用或禁用ca证书。

去调试

导出ca证书pem文件

hcloud Workspace ExportCertPemFile

导出ca证书pem文件。

去调试

导出ca证书crl文件

hcloud Workspace ExportCertCrlFile

导出ca证书crl文件。

去调试

导出ca证书签名请求

hcloud Workspace ExportCertCsrFile

导出ca证书签名请求。

去调试

导入ca子证书

hcloud Workspace ImportCert

导入ca子证书。

去调试

桌面

API名称

命令

描述

操作

根据子网id查询该子网下可用的ip

hcloud Workspace ShowAvailableIp

根据子网id查询该子网下可用的ip。

去调试

sysprep版本信息检查

hcloud Workspace CheckSysprepInfo

检查sysprep版本信息。

去调试

检查桌面镜像是否存在

hcloud Workspace CheckDesktopImages

用于校验指定桌面列表的桌面镜像,当前是否存在,如果存在返回对应的imageId,不存在就不返回。

去调试

批量检查加域

hcloud Workspace BatchCheckDesktopRejoinDomain

该接口用于批量检查桌面是否支持重新加入AD域。

去调试

导出桌面列表

hcloud Workspace ExportDesktopListNew

导出桌面列表的excel文件。

去调试

查询桌面列表

hcloud Workspace ListDesktops

该接口用于查询桌面虚拟机列表。

去调试

创建桌面

hcloud Workspace CreateDesktop

创建桌面,并将此桌面分配给用户,当桌面创建成功后用户可以登录使用。

去调试

查询单个桌面详情

hcloud Workspace ShowDesktopDetail

指定桌面Id查询详细信息。

去调试

修改桌面属性

hcloud Workspace UpdateDesktop

修改桌面属性。

去调试

删除单个桌面

hcloud Workspace DeleteDesktop

删除单个桌面,删除后无法恢复。

去调试

批量删除桌面

hcloud Workspace BatchDeleteDesktops

批量删除桌面,删除后无法恢复。

去调试

批量注销桌面

hcloud Workspace BatchLogoffDesktops

批量注销桌面。

去调试

查询桌面详情列表

hcloud Workspace ListDesktopsDetail

查询桌面详情信息列表。

去调试

操作桌面

hcloud Workspace BatchRunDesktops

批量操作桌面,用于批量开机、关机、休眠和重启。

去调试

变更规格

hcloud Workspace ResizeDesktop

变更云桌面规格,只支持变更CPU和内存,不支持变更磁盘,不支持同规格互相变更。

去调试

重建桌面

hcloud Workspace BatchRebuildDesktopsSystemDisk

批量重建桌面系统盘。

去调试

查询桌面开关机信息

hcloud Workspace ListDesktopActions

获取桌面开关机信息。

去调试

查询桌面监控信息

hcloud Workspace ShowDesktopMonitorData

该接口可获取某一计算机在一段时间段(范围:1小时到30天)的数据信息(例如CPU占用率、内存占用率、用户的在线时间段等),最长数据保存时间不能超过180天。

去调试

远程登录控制台

hcloud Workspace ShowRemoteConsoleAddress

用于直接获取远程登录控制台地址。

去调试

更新桌面SID

hcloud Workspace UpdateDesktopSids

该接口用于桌面sid和WindowsAD中的SID不同时,更新桌面SID使其与AD中的SID保持一致,一般用于解决桌面脱域的情况使用。

去调试

重新加入AD域

hcloud Workspace RegisterDomain

该接口用于Windows桌面重新加入AD域,一般用于解决桌面脱域的情况使用。

去调试

桌面转镜像

hcloud Workspace ChangeDesktopToImage

桌面转镜像。

去调试

批量解绑用户

hcloud Workspace BatchDetachInstances

批量将桌面和用户解绑。

去调试

解绑用户

hcloud Workspace DetachInstances

将桌面和用户解绑。

去调试

分配用户

hcloud Workspace AttachInstances

将桌面分配给用户。

去调试

批量修改用户权限组

hcloud Workspace ChangeUserPrivilegeGroup

批量修改用户权限组。

去调试

查询桌面网络

hcloud Workspace ShowDesktopNetwork

查询桌面vpc、子网、privateIp、EIP、安全组。

去调试

切换桌面网络

hcloud Workspace ChangeDesktopNetwork

切换桌面vpc、子网、ip、安全组。

去调试

批量查询桌面网络

hcloud Workspace ShowDesktopNetworks

查询桌面vpc、子网、privateIp、EIP、安全组。

去调试

批量切换桌面网络

hcloud Workspace BatchChangeDesktopNetwork

批量切换桌面vpc、子网、ip、安全组。

去调试

查询桌面解绑信息

hcloud Workspace ListDesktopDetachInfo

查询桌面解绑信息。

去调试

查询sysprep版本信息

hcloud Workspace ShowSysprepInfo

查询sysprep版本信息。

去调试

批量设置桌面维护模式

hcloud Workspace SetMaintenanceMode

批量设置桌面管理员维护模式。

去调试

预批量分配用户

hcloud Workspace BatchAssociateInstances

预批量将桌面分配给用户。

去调试

批量分配用户

hcloud Workspace BatchAttachInstances

批量分配桌面给用户。

去调试

AD场景支持桌面更换关联用户名

hcloud Workspace UpdateDesktopUsername

AD场景支持桌面更换关联用户名。

去调试

发送消息通知

hcloud Workspace SendNotifications

用于管理员向桌面发送消息通知。

去调试

查询桌面安装监控插件详情

hcloud Workspace ListAgentsInstallCondition

展示桌面安装监控插件详情。

去调试

安装监控插件

hcloud Workspace BatchInstallAgent

批量为桌面安装监控插件。

去调试

根据桌面id查询远程协助信息

hcloud Workspace ShowDesktopRemoteAssistanceInfo

根据桌面id查询远程协助信息。

去调试

创建远程协助

hcloud Workspace CreateRemoteAssistance

创建远程协助。

去调试

取消远程协助

hcloud Workspace CancelRemoteAssistance

取消远程协助。

去调试

查询桌面连接状态列表

hcloud Workspace ListDesktopsConnectStatus

查询桌面连接状态列表。

去调试

查询桌面版本统计信息

hcloud Workspace ListDesktopStatisticsByVersion

查询每个桌面版本下的桌面数量统计信息,支持按版本号过滤。

去调试

查询该版本的桌面列表

hcloud Workspace ListDesktopVersion

根据agent版本号、操作系统类型、桌面名称、用户名等条件查询桌面版本信息列表,支持分页查询。

去调试

导出该版本的桌面列表

hcloud Workspace ExportDesktopVersionList

根据agent版本号、操作系统类型、桌面名称、用户名等条件导出桌面版本列表的Excel文件。

去调试

批量重新加入AD域

hcloud Workspace BatchUpdateDesktopDomain

该接口用于Windows桌面批量重新加入AD域,一般用于解决桌面脱域的情况使用。

去调试

查询休眠类型

hcloud Workspace ShowHibernateType

查询休眠类型

去调试

桌面池

API名称

命令

描述

操作

查询桌面池列表

hcloud Workspace ListDesktopPools

该接口用于查询桌面池列表。

去调试

创建桌面池

hcloud Workspace CreateDesktopPool

创建桌面池,可将此桌面池分配给用户、用户组,用户登录时会绑定其中一个桌面。

去调试

查询桌面池详情

hcloud Workspace ShowDesktopPoolDetail

指定桌面池Id查询详细信息。

去调试

修改桌面池属性

hcloud Workspace UpdateDesktopPool

修改桌面池属性。

去调试

删除桌面池

hcloud Workspace DeleteDesktopPool

当桌面池内无桌面时可删除桌面池,桌面池删除后无法恢复。

去调试

扩容桌面池

hcloud Workspace ExpandDesktopPool

扩容桌面池。

去调试

桌面池绑定用户

hcloud Workspace AttachDesktopPoolUser

将用户绑定到桌面池。

去调试

桌面池变更规格

hcloud Workspace ResizeDesktopPool

桌面池变更规格。

去调试

桌面池重建系统盘

hcloud Workspace RebuildDesktopPool

桌面池重建系统盘。

去调试

桌面池批量添加磁盘

hcloud Workspace AddDesktopPoolVolumes

桌面池批量添加磁盘。

去调试

桌面池批量删除磁盘

hcloud Workspace DeleteDesktopPoolVolumes

桌面池批量删除磁盘。

去调试

桌面池批量扩容磁盘

hcloud Workspace ExpandDesktopPoolVolumes

桌面池批量扩容磁盘。

去调试

操作桌面池

hcloud Workspace ExecuteDesktopPoolAction

操作桌面池,用于桌面池里面的桌面批量开机、关机、重启和休眠。

去调试

查询桌面池授权的用户、用户组

hcloud Workspace ListDesktopPoolAuthorizedObjects

该接口用于查询指定桌面池授权的用户、用户组。

去调试

桌面池授权用户、用户组

hcloud Workspace CreateDesktopPoolAuthorizedObjects

该接口用于桌面池授权用户、用户组。

去调试

查询桌面池中差异统计

hcloud Workspace ListInconsistentStatics

该接口用于查询桌面池中差异统计

去调试

查询桌面池下的桌面信息

hcloud Workspace ListPoolDesktopsDetail

该接口用于查询桌面池下的桌面信息。

去调试

查询桌面池的脚本执行任务列表

hcloud Workspace ShowDesktopPoolsScriptExecTasks

桌面池的脚本执行任务列表。

去调试

桌面池批量执行脚本

hcloud Workspace ExecuteDesktopPoolScript

桌面池批量执行脚本。

去调试

发送消息通知

hcloud Workspace SendDesktopPoolNotifications

用于管理员向桌面发送消息通知。

去调试

查询用户所关联的桌面池列表

hcloud Workspace ListDesktopPoolsByUsers

该接口用于查询用户所关联的桌面池列表

去调试

桌面名称策略

API名称

命令

描述

操作

获取桌面名称策略

hcloud Workspace ListDesktopNamePolicy

获取桌面名称策略,用于自动生成桌面名称。

去调试

创建桌面名称策略

hcloud Workspace CreateDesktopNamePolicy

创建桌面名称策略,用于自动生成桌面名称。

去调试

更新桌面名称策略

hcloud Workspace UpdateDesktopNamePolicy

更新桌面名称策略,用于自动生成桌面名称。

去调试

批量删除桌面名称策略

hcloud Workspace BatchDeleteDesktopNamePolicy

批量删除桌面名称策略。

去调试

桌面标签

API名称

命令

描述

操作

查询桌面标签

hcloud Workspace ShowTagByDesktopId

查询指定桌面的标签信息。

去调试

创建桌面标签

hcloud Workspace CreateTag

该接口用于为桌面创建标签,一个桌面上最多有10个标签。创建时,如果创建的标签已经存在(key相同),则覆盖。

去调试

删除桌面标签

hcloud Workspace DeleteTag

该接口用于删除桌面标签。删除时,如果删除的标签不存在,默认处理成功。

去调试

查询项目标签

hcloud Workspace ListProjectTags

查询租户的所有标签集合。

去调试

批量添加或删除标签

hcloud Workspace BatchChangeTags

为指定桌面批量添加或删除标签。创建时,如果创建的标签已经存在(key相同),则覆盖。删除时,如果删除的标签不存在,默认处理成功。

去调试

使用标签过滤桌面(已废弃)

hcloud Workspace ListDesktopByTags

使用标签过滤桌面。该接口已废弃,请使用post /v2/{project_id}/desktops/resource-instances/action

去调试

使用标签过滤桌面

hcloud Workspace ListDesktopsByTags

使用标签过滤桌面。

去调试

批量添加多个桌面标签

hcloud Workspace BatchAddDesktopsTags

同时对多个桌面批量添加标签,如果创建的标签已经存在(key相同)则覆,最大支持100个桌面,每个桌面最大20个标签。

去调试

批量删除多个桌面标签

hcloud Workspace BatchDeleteDesktopsTags

同时对多个桌面批量添加标签,删除时,如果删除的标签不存在默认处理成功,最大支持100个桌面,每个桌面最大20个标签。

去调试

协同桌面

API名称

命令

描述

操作

桌面购买附属资源

hcloud Workspace AddDesktopSubResources

存量桌面购买附属资源。

去调试

桌面删除附属资源

hcloud Workspace DeleteDesktopSubResources

桌面删除附属资源。

去调试

用户

API名称

命令

描述

操作

导出用户

hcloud Workspace ExportUsersNew

以excel文件形式导出用户。

去调试

查询用户列表

hcloud Workspace ListUsers

该接口用于查询桌面用户列表。

去调试

创建用户

hcloud Workspace CreateDesktopUser

该接口用于创建桌面用户。

去调试

查询用户详情信息

hcloud Workspace ListUserDetail

该接口用于查询指定的桌面用户详情。

去调试

修改用户信息

hcloud Workspace UpdateUserInfo

该接口用于修改桌面用户信息。

去调试

删除指定用户

hcloud Workspace DeleteUser

删除指定的桌面用户。

去调试

批量删除用户

hcloud Workspace BatchDeleteUser

该接口用于批量删除桌面用户。

去调试

用户模板下载

hcloud Workspace ExportUserListTemplate

该接口用于用户模板下载。

去调试

创建用户模板下载

hcloud Workspace ExportUsersTemplate

该接口用于创建用户模板下载。

去调试

批量创建用户

hcloud Workspace BatchCreateUsers

该接口用于批量创建用户。

去调试

导入用户列表

hcloud Workspace ImportUserList

该接口用于导入用户列表。

去调试

操作用户

hcloud Workspace ChangeUserStatus

该接口用于操作用户,包含三种操作:锁定、解锁和重置密码(重置密码建议使用/v2/{project_id}/users/{user_id}/random-password接口,在没有通知方式的情况下必须使用/v2/{project_id}/users/{user_id}/random-password接口)。

去调试

给用户重置随机密码

hcloud Workspace ResetRandomPassword

该接口用于给用户重置一个密码。

去调试

查询OTP设备

hcloud Workspace ListOtpDevicesByUserId

该接口用于查询相应用户下面的OTP设备。

去调试

解绑OTP设备

hcloud Workspace BatchDeleteOtpDevices

该接口用于解绑用户的OTP设备。

去调试

重新发送邮件

hcloud Workspace SendEmail

该接口用于重新发送邮件。

去调试

查询通知拦截记录

hcloud Workspace ListNotificationRecords

查询通知拦截记录

去调试

用户组

API名称

命令

描述

操作

查询用户组列表

hcloud Workspace ListUserGroups

查询用户组列表,支持分页。

去调试

创建用户组

hcloud Workspace CreateUserGroup

该接口用于创建用户组。

去调试

批量删除用户组

hcloud Workspace BatchDeleteUserGroups

该接口用于批量删除用户组。

去调试

修改用户组信息

hcloud Workspace UpdateUserGroup

该接口用于修改用户组信息。

去调试

删除用户组

hcloud Workspace DeleteUserGroup

删除用户组。

去调试

操作用户组

hcloud Workspace RunActionsOnGroup

操作用户组,如添加用户、删除用户。

去调试

查询用户组中的用户

hcloud Workspace ListUsersOfGroup

该接口用于查询用户组中的用户。

去调试

导出用户组

hcloud Workspace ExportUserGroupsNew

以excel文件形式导出用户组。

去调试

导出用户组的用户

hcloud Workspace ExportUserGroupUsersNew

以excel文件形式导出用户组用户。

去调试

导出用户组

hcloud Workspace ExportUserGroups

以excel文件形式导出用户组。

去调试

组织单元

API名称

命令

描述

操作

查询OU列表

hcloud Workspace ListOuDetails

查询OU列表。

去调试

新增OU信息

hcloud Workspace AddOu

该接口用于创建OU。

去调试

更新OU信息

hcloud Workspace UpdateOuInfo

更新OU信息。

去调试

删除OU信息

hcloud Workspace DeleteOu

该接口用于删除OU信息。

去调试

查询AD里的OU列表

hcloud Workspace ListAdOus

查询AD里的OU列表。

去调试

查询OU下用户信息

hcloud Workspace ListAdOuUsers

查询OU下用户信息。

去调试

磁盘

API名称

命令

描述

操作

增加桌面磁盘

hcloud Workspace AddDesktopVolumes

给单个桌面增加磁盘。

去调试

删除桌面数据盘

hcloud Workspace DeleteDesktopVolumes

删除桌面数据盘,删除后无法恢复。

去调试

批量增加桌面磁盘

hcloud Workspace AddVolumes

批量增加桌面磁盘。

去调试

扩容磁盘

hcloud Workspace ExpandDesktopVolume

扩容磁盘。

去调试

扩容桌面磁盘

hcloud Workspace ExpandVolumes

扩容桌面磁盘。

去调试

批量修改磁盘QOS

hcloud Workspace BatchModifyQosVolumes

批量修改磁盘QOS。

去调试

查询磁盘产品信息

hcloud Workspace ListVolumeProductInfo

查询磁盘产品信息。

去调试

快照

API名称

命令

描述

操作

批量创建快照

hcloud Workspace BatchCreateDesktopSnapshot

批量创建快照。

去调试

批量删除快照

hcloud Workspace BatchDeleteDesktopSnapshot

批量删除快照。

去调试

批量恢复快照

hcloud Workspace BatchRestoreDesktopSnapshot

批量恢快照。

去调试

查询快照列表

hcloud Workspace ListDesktopSnapshot

查询快照列表。

去调试

连接信息

API名称

命令

描述

操作

查询桌面登录状态

hcloud Workspace ListInstancesStatus

该接口用于查询桌面登录状态。

去调试

导出连接记录(待废弃)

hcloud Workspace ExportUserLoginInfoNew

该接口用于导出连接记录,待废弃。

去调试

查询登录人数

hcloud Workspace ListHistoryOnlineInfoNew

该接口用于查询登录人数,注意查询参数不可全空。

去调试

查询登录信息

hcloud Workspace ListLoginRecordsNew

该接口用于查询登录信息。

去调试

连接记录

API名称

命令

描述

操作

导出连接记录

hcloud Workspace ExportUserConnectionNew

该接口用于导出连接记录;

去调试

策略组

API名称

命令

描述

操作

查询策略组列表

hcloud Workspace ListPolicyGroup

查询策略组概要信息列表,不包含策略信息以及应用对象信息。

去调试

新增策略组

hcloud Workspace CreatePolicyGroup

新增策略组。

去调试

查询策略组

hcloud Workspace ListPolicyDetailInfoById

根据策略组ID查询策略组详细信息,包含策略信息以及应用对象信息。

去调试

修改策略组

hcloud Workspace UpdatePolicyGroup

修改指定策略组的信息。

去调试

删除策略组

hcloud Workspace DeletePolicyGroup

删除指定策略组,包含策略组对应的策略信息以及应用对象信息。

去调试

导出策略组

hcloud Workspace ExportPolicyGroups

导出xml文件形式的策略组。

去调试

查询策略组中的策略项

hcloud Workspace ListPoliciesOfPolicyGroup

查询指定策略组内的策略项。

去调试

修改策略组中的策略项

hcloud Workspace UpdatePoliciesOfPolicyGroup

修改一个策略组的部分或者所有策略项。

去调试

查询策略组应用对象

hcloud Workspace ListTargetOfPolicyGroup

查询指定策略组所应用的对象。

去调试

修改策略组应用对象

hcloud Workspace BatchUpdateTargetOfPolicyGroup

批量增加、删除应用对象到指定策略组。

去调试

查询策略组详情列表

hcloud Workspace ListPolicyGroupInfo

包含策略信息以及应用对象的信息。

去调试

查询初始策略项

hcloud Workspace ListOriginalPolicyInfo

查询初始策略项。

去调试

创建策略模板

hcloud Workspace CreatePolicyTemplate

创建策略模板。

去调试

导入策略组

hcloud Workspace ImportPolicyGroups

以xml文件形式导入策略组。

去调试

查询接入策略

hcloud Workspace ListAccessPolicies

该接口用于查询接入策略。

去调试

创建接入策略

hcloud Workspace CreateAccessPolicy

该接口用于创建接入策略。

去调试

删除接入策略

hcloud Workspace BatchDeleteAccessPolicies

该接口用于删除指定接入策略。

去调试

更新指定接入策略

hcloud Workspace UpdateAccessPolicy

该接口用于更新指定接入策略。

去调试

查询指定接入策略的应用对象

hcloud Workspace ListAccessPolicyObjects

该接口用于查询指定接入策略的应用对象。

去调试

更新指定接入策略的应用对象

hcloud Workspace UpdateAccessPolicyObjects

该接口用于更新指定接入策略的应用对象。

去调试

导入ip列表

hcloud Workspace ImportIp

以excel文件形式导入ip列表。

去调试

导入ip模板下载

hcloud Workspace ExportIpTemplate

该接口用于导入Ip模板下载。

去调试

终端与桌面绑定

API名称

命令

描述

操作

导出终端与桌面绑定配置excel

hcloud Workspace ExportTerminalsBindingDesktopsInfoNew

导出终端与桌面绑定配置excel。

去调试

查询终端与桌面绑定的开关配置信息

hcloud Workspace ListTerminalsBindingDesktopsConfig

查询终端与桌面绑定的开关配置信息。

去调试

设置终端与桌面绑定的开关配置

hcloud Workspace UpdateTerminalsBindingDesktopsConfig

设置终端与桌面绑定的开关配置。

去调试

查询终端与桌面绑定配置列表

hcloud Workspace ListTerminalsBindingDesktops

查询终端与桌面绑定配置列表。

去调试

增加终端与桌面绑定配置

hcloud Workspace CreateTerminalsBindingDesktops

增加终端与桌面绑定配置。

去调试

修改终端与桌面绑定配置

hcloud Workspace UpdateTerminalsBindingDesktops

修改终端与桌面绑定配置。

去调试

删除终端与桌面绑定配置

hcloud Workspace DeleteTerminalsBindingDesktops

删除终端与桌面绑定配置。

去调试

下载终端与桌面绑定模板

hcloud Workspace ExportTerminalsBindingDesktopsTemplate

下载终端与桌面绑定模板。

去调试

云办公主机

API名称

命令

描述

操作

查询云办公主机包含桌面信息

hcloud Workspace ListServersByHostId

查询云办公主机包含桌面信息,提供给console使用。

去调试

查询云办公主机列表

hcloud Workspace ListHostsDetail

展示云办公主机列表的详情。

去调试

更新云办公主机信息

hcloud Workspace UpdateHosts

通过云办公主机的id更新云办公主机的信息,提供给console、赞齐使用。

去调试

导出云办公主机列表

hcloud Workspace ExportHostsDetail

导出云办公主机列表的详情

去调试

订单

API名称

命令

描述

操作

包周期下单

hcloud Workspace CreateOrder

包周期资源(桌面、磁盘)下订单。

去调试

创建变更订单

hcloud Workspace CreateChangeOrder

变更规格、扩容磁盘。

去调试

包周期桌面批量变更下单

hcloud Workspace CreateDesktopBatchOrder

包周期桌面批量变更下单。

去调试

批量包周期桌面切换镜像询价

hcloud Workspace EstimateChangeImages

批量包周期桌面切换镜像(由不收费镜像变更至收费镜像)询价。

去调试

包周期桌面池批量变更下单

hcloud Workspace CreateDesktopPoolChangeOrder

包周期桌面池批量变更下单。

去调试

包周期桌面池添加单个磁盘批量询价

hcloud Workspace EstimateDesktopPoolAddVolume

包周期桌面池添加单个磁盘批量询价。

去调试

包周期桌面池切换镜像批量询价

hcloud Workspace EstimateDesktopPoolChangeImage

包周期桌面池切换镜像(由不收费镜像变更至收费镜像)批量询价。

去调试

包周期桌面池扩容磁盘批量询价

hcloud Workspace EstimateDesktopPoolExtendVolume

包周期桌面池扩容磁盘批量询价。

去调试

包周期桌面池变更规格批量询价

hcloud Workspace EstimateDesktopPoolResize

包周期桌面池变更规格批量询价。

去调试

包周期桌面增配变更批量询价

hcloud Workspace EstimateAddResources

包周期桌面增配变更批量询价。

去调试

包周期云办公带宽变更下单

hcloud Workspace CreateSubnetBandwidthChangeOrder

包周期云办公带宽变更下单。

去调试

创建桌面订单

hcloud Workspace CreateDesktopOrder

创建桌面订单。

去调试

创建资源包订单

hcloud Workspace CreateResourcePackagesOrder

创建资源包订单。

去调试

产品套餐

API名称

命令

描述

操作

查询产品套餐列表

hcloud Workspace ListProducts

该接口用于查询云桌面支持的产品套餐列表。

去调试

查询可订购小时包类型

hcloud Workspace ListHourPackagesType

该接口用于查询可订购小时包类型。

去调试

查询协同套餐列表

hcloud Workspace ListSharerProducts

该接口用于查询协同套餐列表。

去调试

查询按需资源包列表

hcloud Workspace ListResourcePackages

该接口用于查询按需资源包列表。

去调试

录屏审计

API名称

命令

描述

操作

查询录屏记录列表

hcloud Workspace ListScreenRecords

查询录屏记录列表。

去调试

查询录屏详情

hcloud Workspace ShowScreenRecord

查询录屏详情。

去调试

更新录屏全速上传详情

hcloud Workspace UpdateScreenRecords

更新录屏全速上传详情。

去调试

批量删除录屏记录

hcloud Workspace BatchDeleteScreenRecords

批量删除录屏记录。

去调试

查询下载地址列表

hcloud Workspace ListDownloadAddress

查询下载地址列表。

去调试

查询桌面关键事件列表

hcloud Workspace ListDesktopOperations

查询桌面关键事件列表。

去调试

查询站点录屏限速配置

hcloud Workspace ListScreenRecordsTrafficLimitConfig

查询站点录屏限速配置。

去调试

更新站点录屏限速配置

hcloud Workspace UpdateScreenRecordsTrafficLimitConfig

更新站点录屏限速配置。

去调试

定时任务

API名称

命令

描述

操作

查询定时任务列表

hcloud Workspace ListScheduledTasks

查询定时任务列表。

去调试

创建定时任务

hcloud Workspace CreateScheduledTasks

创建定时任务。

去调试

查询定时任务详情

hcloud Workspace ShowScheduledTasks

查询定时任务详情。

去调试

修改定时任务

hcloud Workspace UpdateScheduledTasks

修改定时任务。

去调试

删除定时任务

hcloud Workspace DeleteScheduledTasks

删除定时任务。

去调试

未来执行的具体时间列表

hcloud Workspace ListFutureExecutions

未来执行的具体时间列表。

去调试

批量删除定时任务

hcloud Workspace BatchDeleteScheduledTasks

批量删除定时任务。

去调试

查询定时任务执行记录

hcloud Workspace ListScheduledTasksRecords

查询定时任务执行记录。

去调试

查询定时任务执行记录详情

hcloud Workspace ListScheduledTasksRecordsDetails

查询定时任务执行记录详情。

去调试

导出定时任务记录及执行详情

hcloud Workspace ExportScheduledTasksRecords

导出定时任务记录及执行详情。

去调试

查询生命周期类型配置

hcloud Workspace ListLifeCycleTypeConfigurations

根据type查询Apollo配置项life.cycle.type.action,获取对应的配置信息。不传type时返回所有配置项。

去调试

获取时区配置

hcloud Workspace ListTimeZones

获取时区配置。

去调试

导出中心

API名称

命令

描述

操作

查询导出任务列表

hcloud Workspace ListExportTasks

查询导出任务列表。

去调试

批量删除导出任务记录

hcloud Workspace DeleteExportTasks

批量删除导出任务记录。

去调试

下载导出的文件

hcloud Workspace DownloadExportFile

下载导出的文件。

去调试

报表统计

API名称

命令

描述

操作

桌面统计

hcloud Workspace ListDesktopsStatistics

统计租户下的普通桌面、桌面池状态,默认仅统计总数。

去调试

运行状态统计

hcloud Workspace ListRunState

租户桌面运行状态统计。

去调试

登录状态统计

hcloud Workspace ListLoginState

查询租户桌面登录状态统计。

去调试

查询在指定时间段未使用的桌面

hcloud Workspace ListUnusedDesktops

查询在指定时间段未使用的桌面。已废弃,不推荐使用。统计数据推荐使用查询桌面使用情况统计数据接口查询用户使用统计数据接口

去调试

查询使用桌面的时长

hcloud Workspace ListUsedDesktopInfo

查询使用桌面的时长。已废弃,不推荐使用。统计数据推荐使用查询桌面使用情况统计数据接口查询用户使用统计数据接口

去调试

查询指标环比值

hcloud Workspace ShowGrowthRate

查询指标环比值。

去调试

查询指标

hcloud Workspace ListMetrics

查询指标。

去调试

查询指标趋势

hcloud Workspace ListMetricsTrend

查询指标趋势。

去调试

更新通知规则

hcloud Workspace UpdateMetricNotifyRule

更新对应指标的通知规则;对应指标满足相应的规则条件时发送通知。

去调试

删除通知规则

hcloud Workspace DeleteMetricNotifyRule

删除对应指标的通知规则;对应指标满足相应的规则条件时发送通知

去调试

查询通知规则

hcloud Workspace ListMetricNotifyRule

查询对应指标的通知规则;。

去调试

新增通知规则

hcloud Workspace AddMetricNotifyRule

新增对应指标的通知规则;对应指标满足相应的规则条件时发送通知

去调试

查询对应指标维度是否存在满足通知规则的记录

hcloud Workspace ListMetricNotifyRecord

查询对应指标维度是否存在满足通知规则的记录;

去调试

查询桌面使用情况统计数据

hcloud Workspace ListDesktopUsageMetric

查询桌面使用统计信息;

去调试

查询用户使用统计数据

hcloud Workspace ListUserUsageMetric

查询用户使用统计信息;

去调试

查询云应用接入统计数据

hcloud Workspace ListAppUserAccessData

查询云应用接入统计数据,一次最多查询30天,支持最近30天的数据查询。

去调试

导出云应用接入统计数据

hcloud Workspace ExportAppUserAccessData

创建云应用接入统计导出任务,仅能导出最近30天的数据。创建后根据taskId调用ListExportTasks查询任务状态,调用DownloadExportFile下载导出文件。

去调试

查询接入云桌面或云应用各阶段时长数据

hcloud Workspace ShowUserAccessStages

查询接入云桌面或云应用各阶段时长数据。

去调试

导出桌面使用统计数据

hcloud Workspace ExportDesktopUsageMetricNew

导出桌面使用统计信息;

去调试

导出用户使用统计数据

hcloud Workspace ExportUserUsageMetricNew

导出用户使用统计信息;

去调试

用户操作日志

API名称

命令

描述

操作

查询用户事件

hcloud Workspace ListUserEvents

查询用户事件,一次最多查询30天,支持最近30天的数据查询。

去调试

查询用户事件LTS配置

hcloud Workspace ListUserEventsLtsConfigurations

查询用户事件LTS配置。

去调试

配置用户事件LTS

hcloud Workspace SetUserEventsLtsConfigurations

配置用户事件LTS。

去调试

脚本

API名称

命令

描述

操作

查询脚本列表

hcloud Workspace ListScripts

查询脚本列表。

去调试

新增脚本

hcloud Workspace CreateScript

新增脚本。

去调试

查询脚本详情

hcloud Workspace ShowScriptDetail

查询脚本详情。

去调试

更新脚本

hcloud Workspace UpdateScript

更新脚本。

去调试

删除脚本

hcloud Workspace DeleteScript

删除脚本。

去调试

批量执行脚本或命令

hcloud Workspace ExecuteScriptOrCommand

批量执行脚本或命令。

去调试

查询脚本执行记录详情

hcloud Workspace ShowScriptRecordDetail

查询脚本执行记录详情。

去调试

查询脚本执行记录列表

hcloud Workspace ListScriptRecords

查询脚本执行记录列表。

去调试

查询脚本任务列表

hcloud Workspace ListScriptTasks

查询脚本任务列表。

去调试

重试脚本或执行脚本失败的任务

hcloud Workspace RetryScriptExecution

重试脚本或执行脚本失败的任务。

去调试

停止脚本或者命令执行任务

hcloud Workspace StopScriptExecution

停止脚本或者命令执行任务。

去调试

按桌面标签下发执行脚本或命令

hcloud Workspace ExecuteScriptByDesktopTag

按桌面标签下发执行脚本或命令。

去调试

配额

API名称

命令

描述

操作

查询租户配额

hcloud Workspace ShowQuotas

Console Framework和WKSDesktopManager调用该接口查询租户配额。

去调试

查询租户单个站点配额详情

hcloud Workspace ShowQuotaDetails

查询租户单个站点配额详情。

去调试

镜像

API名称

命令

描述

操作

获取云市场镜像列表

hcloud Workspace ListMarketImages

获取云市场镜像列表。

去调试

查询产品镜像列表

hcloud Workspace ListImages

该接口用于查询云桌面支持的产品镜像列表。

去调试

可用分区

API名称

命令

描述

操作

查询可用分区列表

hcloud Workspace ListAvailabilityZones

该接口用于查询云桌面支持的可用分区列表。

去调试

查询可用分区列表概要

hcloud Workspace ListAzs

该接口用于查询云桌面支持的可用分区列表。

去调试

查询可用分区详情

hcloud Workspace ShowAzDetails

该接口用于查询云桌面支持的可用分区列表。

去调试

任务

API名称

命令

描述

操作

查询任务详情

hcloud Workspace ShowJob

该接口用于查询异步任务的执行情况,比如查询创建桌面任务的执行状态。

去调试

子任务查询

hcloud Workspace ListItaSubJobs

该接口用于查询异步任务执行情况,比如查询创建桌面的执行状态。

去调试

删除子任务

hcloud Workspace BatchDeleteSubJobs

该接口用于删除子任务,changeAccessVpc,cancelWorkspace,applyWorkspace类型任务不支持删除。

去调试

重试任务

hcloud Workspace RunActionsOnWorkspaceJob

该接口用来对失败的任务进行重试,当前仅支持开户和销户的任务重试。

去调试

网络

API名称

命令

描述

操作

查询上网功能

hcloud Workspace ListInternet

查询上网功能。

去调试

开通上网功能

hcloud Workspace ApplyInternet

开通上网功能。

去调试

查询已绑定桌面和未绑定的EIP

hcloud Workspace ListDesktopsEips

查询已绑定桌面和未绑定的EIP。

去调试

开通桌面上网功能

hcloud Workspace ApplyDesktopsInternet

开通桌面上网功能。

去调试

桌面绑定EIP

hcloud Workspace AssociateDesktopsEip

桌面绑定EIP。

去调试

批量桌面解绑EIP

hcloud Workspace BatchDisassociateDesktopsEip

批量桌面解绑EIP。

去调试

查询正在被使用的子网id列表

hcloud Workspace ShowUsingSubnets

根据子网id列表查询正在被桌面使用的子网id,并且返回subnetId列表。

去调试

查询端口列表

hcloud Workspace ListPorts

查询端口列表。

去调试

查询NAT网关列表

hcloud Workspace ListNatGateways

查询NAT网关列表。

去调试

查询云办公带宽列表

hcloud Workspace ListSubnetBandwidths

查询云办公带宽列表。

去调试

创建云办公带宽

hcloud Workspace ApplySubnetBandwidth

创建按需云办公带宽。

去调试

修改云办公带宽

hcloud Workspace UpdateSubnetBandwidth

修改云办公带宽。

去调试

删除云办公带宽

hcloud Workspace DeleteSubnetBandwidth

删除云办公带宽。

去调试

查询云办公带宽的控制配置

hcloud Workspace ShowSubnetBandwidthControlList

查询云办公带宽的控制配置。

去调试

修改云办公带宽的控制配置

hcloud Workspace UpdateSubnetBandwidthControlList

修改云办公带宽的控制配置。

去调试

查询安全组列表

hcloud Workspace ListSecurityGroups

该接口查询安全组列表。

去调试

查询vpc

hcloud Workspace ListVpcInfo

查询vpc。

去调试

查询子网列表

hcloud Workspace ListSubnets

查询子网列表。

去调试

校验租户冲突网段

hcloud Workspace CheckCidr

该接口用于校验租户网段是否冲突,返回冲突网段列表

去调试

委托

API名称

命令

描述

操作

查询委托功能

hcloud Workspace ListAgencies

查询委托功能。

去调试

开通委托功能

hcloud Workspace CreateAgencies

开通委托功能。

去调试

应用中心

API名称

命令

描述

操作

生成访问凭证信息

hcloud Workspace CreateBucketCredential

生成桶凭证信息。

去调试

添加并授权默认桶

hcloud Workspace CreateAndAuthorizeBucket

添加并授权默认桶,桶不存在时会自动创建OBS桶。

去调试

按照名称分页查询应用

hcloud Workspace ListApps

按照名称分页查询应用。

去调试

添加应用

hcloud Workspace UploadApp

添加应用应用。

去调试

删除应用

hcloud Workspace DeleteApp

删除应用。

去调试

修改应用

hcloud Workspace UpdateUploadedApp

修改应用。

去调试

自动安装应用

hcloud Workspace InstallApp

自动安装应用(应用需支持静默安装或者解压安装)。

去调试

查询应用授权信息

hcloud Workspace ListAppAuthorizations

查询应用授权信息。

去调试

设置应用授权

hcloud Workspace UpdateAppAuthorizations

设置应用授权。

去调试

批量删除应用

hcloud Workspace BatchDeleteApps

批量删除应用。

去调试

批量设置不可见

hcloud Workspace BatchDisableApps

批量设置不可见。

去调试

批量设置可见

hcloud Workspace BatchEnableApps

批量设置可见。

去调试

批量设置应用授权

hcloud Workspace BatchUpdateAppAuthorizations

批量设置应用授权。

去调试

批量自动安装安装应用

hcloud Workspace BatchInstallApps

批量自动安装安装应用 (应用需支持静默安装或者解压安装)。

去调试

查询应用分类信息

hcloud Workspace ListAppCatalogs

查询应用分类信息。

去调试

查询应用安装job信息

hcloud Workspace ListJobs

查询应用安装job信息。

去调试

批量删除job

hcloud Workspace BatchDeleteJobs

批量删除job。

去调试

重试失败job

hcloud Workspace RetryJobs

重试指定失败job(仅支持失败job重试,其他类型job重试会响应错误)。

去调试

应用管控

API名称

命令

描述

操作

查询应用规则

hcloud Workspace ListAppRule

查询应用规则。

去调试

创建应用规则

hcloud Workspace CreateAppRule

创建应用规则。

去调试

删除应用规则

hcloud Workspace DeleteAppRule

删除应用规则。

去调试

修改应用规则

hcloud Workspace UpdateAppRule

修改应用规则。

去调试

批量删除规则

hcloud Workspace BatchDeleteAppRules

批量删除规则。

去调试

启用规则管控

hcloud Workspace EnableRuleRestriction

启用规则管控。

去调试

禁用规则管控

hcloud Workspace DisableRuleRestriction

禁用规则管控。

去调试

查询管控规则

hcloud Workspace ShowRuleRestriction

查询对应管控规则。

去调试

设置管控规则

hcloud Workspace SetRuleRestriction

设置管控规则。

去调试

查询管控规则列表

hcloud Workspace ListRestrictedRule

查询管控规则列表。

去调试

增加管控规则

hcloud Workspace AddRestrictedRule

增加管控规则。

去调试

批量删除管控规则

hcloud Workspace DeleteRestrictedRule

批量删除管控规则。

去调试

Agent实例管理

API名称

命令

描述

操作

查询 Agent 实例列表

hcloud Workspace ListAgentInstances

查询 Agent 实例列表,支持多条件筛选、排序和分页。

去调试

查询 Agent 实例统计信息

hcloud Workspace ListInstanceStatistics

查询 Agent 实例统计信息,包括桌面总数、未配置模型桌面数、未配置通道桌面数、存在风险桌面数。

去调试

查询 Agent 实例关联的模型分组列表

hcloud Workspace ListInstanceModelGroups

根据 Agent 实例 ID 查询其关联的所有模型分组,按优先级升序排列,支持分页。

去调试

IM通道配置管理

API名称

命令

描述

操作

下发 IM 通道配置

hcloud Workspace SaveImChannels

配置 IM 通道(钉钉/企业微信/飞书/wework)。

去调试

查询 IM 通道配置列表

hcloud Workspace ListImChannels

根据 Agent 实例主键 ID 查询其配置的 IM 通道列表。

去调试

删除 IM 通道配置

hcloud Workspace DeleteImChannel

删除指定 Agent 实例上某个平台的 IM 通道配置。

去调试

模型配置

API名称

命令

描述

操作

批量关联模型分组与资源(桌面/桌面标签)

hcloud Workspace ApplyModelConfig

批量关联模型分组与资源。支持根据模型分组关联桌面/桌面标签,也支持根据桌面/桌面标签关联模型分组。

去调试

批量移除模型分组与资源的关联

hcloud Workspace RemoveModelConfig

批量移除模型分组与资源(桌面/桌面标签)的关联。

去调试

模型组

API名称

命令

描述

操作

查询模型组列表

hcloud Workspace ListModelGroups

查询模型组列表,支持模糊搜索。

去调试

新增模型组

hcloud Workspace CreateModelGroup

新增模型组,支持同时关联供应商。

去调试

查询模型组详情

hcloud Workspace ShowModelGroup

查询模型组详情,包含关联的供应商简化信息。

去调试

更新模型组

hcloud Workspace UpdateModelGroup

更新模型组信息。

去调试

删除模型组

hcloud Workspace DeleteModelGroup

删除模型组。如果模型组已被Agent实例或桌面标签授权绑定,禁止删除,返回422错误。

去调试

批量绑定供应商到模型组

hcloud Workspace BatchBindProviders

批量添加供应商关联到指定模型分组。

去调试

查询模型分组关联的应用对象列表

hcloud Workspace ListModelGroupResources

分页查询模型分组关联的应用对象(Agent实例或桌面标签)。

去调试

查询模型组关联的供应商列表

hcloud Workspace ListModelGroupProviders

分页查询模型组关联的供应商。

去调试

批量解绑供应商从模型组

hcloud Workspace BatchDeleteProviders

批量移除供应商关联,当全部成功时返回200,部分成功时返回207。

去调试

模型供应商

API名称

命令

描述

操作

查询供应商模板列表

hcloud Workspace ListProviderTemplates

获取内置供应商模板列表(hw_maas、deepseek)。

去调试

验证供应商配置

hcloud Workspace VerifyProvider

验证供应商连通性和 API Key 有效性。

去调试

查询供应商远程模型列表

hcloud Workspace ListRemoteProviderModels

根据供应商配置查询第三方平台的可用模型列表。

去调试

查询供应商配置列表

hcloud Workspace ListProviders

获取供应商列表,支持分页和多维度筛选。

去调试

新增供应商配置

hcloud Workspace CreateProvider

创建供应商,支持同时批量创建关联的模型。

去调试

查询供应商详情

hcloud Workspace ShowProvider

获取供应商详情,包含关联的分组列表和下属模型列表。

去调试

更新供应商配置

hcloud Workspace UpdateProvider

更新供应商信息。

去调试

删除供应商配置

hcloud Workspace DeleteProvider

删除供应商。删除成功后自动删除下属所有模型记录;触发模型重新下发事件。

去调试

模型管理

API名称

命令

描述

操作

批量新增模型

hcloud Workspace BatchCreateModel

批量创建模型(供应商已存在后追加新增模型)。

去调试

批量删除模型

hcloud Workspace BatchDeleteModel

批量删除模型(支持部分失败)。

去调试

查询模型列表

hcloud Workspace ListModels

获取指定供应商下的模型列表,支持分页。

去调试

查询模型详情

hcloud Workspace ShowModel

获取模型详情。

去调试

更新模型

hcloud Workspace UpdateModel

更新模型信息。

去调试

Skills管理

API名称

命令

描述

操作

查询企业自研技能列表

hcloud Workspace ListSkills

查询企业自研技能列表,支持按分类、状态过滤。

去调试

创建企业自研技能

hcloud Workspace CreateSkill

创建企业自研技能,支持同时上传技能包。

去调试

查询企业自研技能详情

hcloud Workspace ShowSkill

查询企业自研技能详情,包含技能包摘要列表。

去调试

更新企业自研技能

hcloud Workspace UpdateSkill

更新企业自研技能信息。

去调试

删除企业自研技能

hcloud Workspace DeleteSkill

删除企业自研技能。

去调试

升级策略管理服务

API名称

命令

描述

操作

查询升级策略列表

hcloud Workspace ListTenantUpgradeStrategies

分页查询升级策略列表。

去调试

导出升级策略列表

hcloud Workspace ExportTenantUpgradeStrategies

异步导出升级策略数据。

去调试

查询升级策略应用对象列表

hcloud Workspace ListApplyObjects

分页查询指定策略下的应用对象列表。

去调试

批量更新升级策略应用对象

hcloud Workspace UpdateStrategyApplyObjects

批量操作指定策略关联的应用对象。

去调试

创建升级策略

hcloud Workspace CreateTenantUpgradeStrategy

创建升级策略,同时支持关联应用对象。

去调试

批量删除升级策略

hcloud Workspace DeleteTenantUpgradeStrategy

批量删除升级策略。

去调试

修改升级策略

hcloud Workspace UpdateTenantUpgradeStrategy

修改升级策略,同时支持更新关联的应用对象信息。

去调试

升级任务管理服务

API名称

命令

描述

操作

查询升级任务列表

hcloud Workspace ListUpgradeTasks

分页查询升级任务列表。

去调试

查询升级任务应用对象列表

hcloud Workspace ListTaskApplyObjects

分页查询指定任务下的应用对象列表。

去调试

创建升级定时任务

hcloud Workspace CreateUpgradeScheduleTask

创建升级任务,支持配置定时任务、执行策略、灰度策略、应用对象等。

去调试

批量删除升级任务

hcloud Workspace DeleteUpgradeTask

批量删除指定的升级任务。

去调试

查询升级任务详情

hcloud Workspace ShowUpgradeTaskDetail

根据任务ID查询升级任务详情。

去调试

修改升级任务

hcloud Workspace UpdateUpgradeTask

修改升级任务配置。

去调试

触发升级任务

hcloud Workspace ExecuteTriggerUpgrade

根据配置参数触发桌面升级任务。

去调试

租户版本配置管理服务

API名称

命令

描述

操作

查询版本详情

hcloud Workspace ShowTenantVersionConfig

查询版本详情

去调试

查询版本列表

hcloud Workspace ListTenantVersionConfig

查询版本列表,支持按版本类型、版本号、操作系统类型、发布时间段、版本状态、版本说明条件查询。版本说明模糊查询会同时搜索SRE配置的版本说明和租户自定义的版本说明。

去调试

AI功能

API名称

命令

描述

操作

查询订阅AI助手的项目,用户组,用户列表

hcloud Workspace ListSubscribeAiAssistantUsers

查询订阅AI助手的项目,用户组,用户列表

去调试

订阅和取消AI助手

hcloud Workspace SubscribeAiAssistant

订阅用户可以使用ai提供的能力。

去调试

查询用户使用频次统计

hcloud Workspace ShowAiAssistantUsageFrequency

查询用户使用频次统计。

去调试

告警

API名称

命令

描述

操作

查询告警列表

hcloud Workspace ListAlarms

从ces查询告警列表。

去调试

查询告警统计

hcloud Workspace ListAlarmStatistics

返回各级别告警数。

去调试

CommonSkills

API名称

命令

描述

操作

查询公共技能列表(只读)

hcloud Workspace ListCommonSkills

企业租户查询公共技能列表(只读),支持按分类、状态过滤。

去调试

查询公共技能详情(只读)

hcloud Workspace ShowCommonSkill

企业租户查询公共技能详情(只读)。

去调试

SkillPackages

API名称

命令

描述

操作

生成上传地址

hcloud Workspace CreateUploadUrls

生成OBS预签名上传地址,用于企业自研技能包上传。

去调试

批量查询技能包

hcloud Workspace BatchListSkillPackages

根据技能ID列表批量查询当前生效的技能包信息。

去调试

查询技能包列表

hcloud Workspace ListSkillPackages

查询企业自研技能的技能包列表。

去调试

创建技能包

hcloud Workspace CreateSkillPackage

为企业自研技能上传新版本技能包。

去调试

查询技能包详情

hcloud Workspace ShowSkillPackage

查询企业自研技能的技能包详情。

去调试

更新技能包

hcloud Workspace UpdateSkillPackage

更新企业自研技能的技能包信息。

去调试

删除技能包

hcloud Workspace DeleteSkillPackage

删除企业自研技能的技能包。

去调试

生成下载地址

hcloud Workspace CreateDownloadUrl

生成企业自研技能包的OBS预签名下载地址。

去调试

扩展技能包区域

hcloud Workspace ExpandSkillPackageRegion

为企业自研技能包扩展新的OBS区域。

去调试

移除技能包区域

hcloud Workspace RemoveSkillPackageRegion

批量移除企业自研技能包的OBS区域。

去调试

查询公共技能包列表(只读)

hcloud Workspace ListCommonSkillPackages

企业租户查询公共技能的技能包列表(只读)。

去调试

查询公共技能包详情(只读)

hcloud Workspace ShowCommonSkillPackage

企业租户查询公共技能的技能包详情(只读)。

去调试

SkillBindings

API名称

命令

描述

操作

创建技能绑定

hcloud Workspace CreateSkillBindings

批量绑定技能到实例。

去调试

删除技能绑定

hcloud Workspace DeleteSkillBindings

批量解绑技能。

去调试

更新安全策略管控

hcloud Workspace UpdateSecurityPolicyControl

批量更新实例的安全策略管控状态。

去调试

查询安全策略管控资源列表

hcloud Workspace ListSecurityPolicyControlResources

查询安全策略管控的资源列表。

去调试

查询公共技能绑定的资源列表

hcloud Workspace ListCommonSkillResources

查询公共技能绑定的资源列表。

去调试

查询企业技能绑定的资源列表

hcloud Workspace ListSkillResources

查询企业自研技能绑定的资源列表。

去调试

查询实例绑定的技能列表

hcloud Workspace ListInstanceSkills

查询实例绑定的技能列表。

去调试