CLI Command Reference (Workspace)

Querying Tenant Function Statuses

hcloud Workspace ListTenantProfiles

Queries tenant function statuses.

Go debug

Enabling/Disabling Tenant Functions

hcloud Workspace UpdateTenantProfile

Enables/Disables tenant functions.

Go debug

Obtaining the Backup Configuration of a Workspace Access Address

hcloud Workspace ListAccessAddressBackupConfig

Obtains the backup configuration of a Workspace access address.

Go debug

Modifying the Backup Configuration of a Workspace Access Address

hcloud Workspace UpdateAccessAddressBackupConfig

Modifies the backup configuration of a Workspace access address.

Go debug

Querying Authentication-based Login Modes

hcloud Workspace ShowAuthConfig

Queries the configuration of an authentication-based login mode.

Go debug

Updating the Authentication Policy Configuration

hcloud Workspace UpdateAuthMethodConfig

Updates the authentication policy configuration.

Go debug

Querying the Auxiliary Authentication Configuration

hcloud Workspace ShowAssistAuthConfig

Queries auxiliary authentication configurations.

Go debug

Updating the Auxiliary Authentication Policy Configuration

hcloud Workspace UpdateAssistAuthMethodConfig

Updates the auxiliary authentication policy configuration.

Go debug

Listing Auxiliary Authentication Target Objects

hcloud Workspace ShowAssistAuthConfigApplyObjects

Lists auxiliary authentication target objects.

Go debug

Updating Auxiliary Authentication Target Objects

hcloud Workspace UpdateAssistAuthConfigApplyObjects

Updates the list of auxiliary authentication target objects.

Go debug

Downloading SAML 2.0 Metadata

hcloud Workspace DownloadMetadata

Downloads SAML 2.0 metadata.

Go debug

Downloading SAML 2.0 SP Metadata

hcloud Workspace DownloadSpMetadata

Downloads SAML 2.0 SP metadata.

Go debug

Verifying Configurations (Only for SAML 2.0 Configurations)

hcloud Workspace ValidateConfig

Verifies whether configurations are valid. Only SAML 2.0 configurations can be verified.

Go debug

Incrementally Updating an Authentication Configuration

hcloud Workspace UpdateAuthConfig

Incrementally update a specified authentication configuration.

Go debug

Querying Custom Tenant Configurations

hcloud Workspace ListTenantConfigs

Queries custom tenant configurations.

Go debug

Modifying a Custom Tenant Configuration

hcloud Workspace UpdateTenantConfig

Modifies a custom tenant configuration.

Go debug

Querying Default User Configurations of a Collaborative Desktop

hcloud Workspace ShowShareSpaceConfig

Queries default user configurations of a collaborative desktop. (This function is in the open beta test. To use it, contact the administrator.)

Go debug

Setting Default User Configurations of a Collaborative Desktop

hcloud Workspace UpdateShareSpaceConfig

Sets default user configurations of a collaborative desktop. (This function is in the open beta test. To use it, contact the administrator.)

Go debug

Querying NAT Mapping Configuration Items of a Tenant

hcloud Workspace ListNatMappingConfigs

Queries NAT mapping configuration items of a tenant.

Go debug

Modifying NAT Mapping Configuration Items of a Tenant

hcloud Workspace UpdateNatMappingConfigs

Modifies NAT mapping configuration items of a tenant.

Go debug

Querying Site Information

hcloud Workspace ListSiteConfigs

Queries site information.

Go debug

Adding a Site

hcloud Workspace AddSite

API for adding site information.

Go debug

Deleting a Site

hcloud Workspace DeleteSite

Deletes a site.

Go debug

Resetting Site Authentication Information

hcloud Workspace ResetSiteAuthConfig

Resets site authentication information.

Go debug

Modifying the Self-Service Maintenance Channel for a Site Direct Connect Connection

hcloud Workspace UpdateDcVnc

Updates site properties.

Go debug

Changing the Site Access Mode

hcloud Workspace UpdateAccessMode

Changes the site access mode.

Go debug

Modifying a Site Service Subnet

hcloud Workspace UpdateSubnetIds

Modifies a site service subnet.

Go debug

Querying Edge Sites

hcloud Workspace ListWksEdgeSites

Queries edge sites.

Go debug

Checking Edge Site Resources

hcloud Workspace CheckEdgeSiteResources

Checks edge site resources.

Go debug

Querying Domain Controller Configuration

hcloud Workspace ShowDomainsNew

Queries domain controller configuration.

Go debug

Configuring a Domain Controller

hcloud Workspace CreateDomainNew

Configures a domain controller.

Go debug

Modifying a Domain Controller

hcloud Workspace UpdateDomainNew

Modifies a domain controller.

Go debug

Deleting Domain Controller Configurations

hcloud Workspace CloseDomainNew

Deleting domain controller configurations. Currently, AD domain controller configurations cannot be deleted.

Go debug

Synchronizing Domain Controller Users or User Groups

hcloud Workspace SyncExternalUser

Synchronizes domain controller users or user groups.

Go debug

Querying Workspace Service Details

hcloud Workspace ListWorkspaces

Queries Huawei Cloud Workspace details.

Go debug

Subscribing to Workspace

hcloud Workspace ApplyWorkspace

Subscribes to Huawei Cloud Workspace.

Go debug

Modifying Workspace Attributes

hcloud Workspace UpdateWorkspace

Modifies attributes of Huawei Cloud Workspace. Only one attribute type can be modified in a single request.

Go debug

Unsubscribing from Workspace

hcloud Workspace CancelWorkspace

Unsubscribes from Huawei Cloud Workspace. Ensure that the desktop of the current user has been deleted before unsubscription. The desktop cannot be restored after unsubscription.

Go debug

Checking Whether an Enterprise ID Has Been Used

hcloud Workspace CheckEnterpriseId

Checks whether an enterprise ID has been used.

Go debug

Modifying an Enterprise ID

hcloud Workspace UpdateEnterpriseId

Modifies the enterprise ID of a tenant.

Go debug

Checking Whether Workspace Is Locked

hcloud Workspace ShowWorkspaceLock

Queries whether Huawei Cloud Workspace is locked.

Go debug

Unlocking Workspace

hcloud Workspace UnlockWorkspace

Unlocks Huawei Cloud Workspace.

Go debug

Verifying Domain Management

hcloud Workspace ValidateDomainController

Verifies domain management.

Go debug

Listing CA Certificates

hcloud Workspace ListCerts

Lists CA certificates.

Go debug

Creating a Certificate

hcloud Workspace CreateCert

Creates a certificate.

Go debug

Querying CA Certificate Details

hcloud Workspace ShowCertDetail

Queries details about a CA certificate.

Go debug

Deleting a CA Certificate

hcloud Workspace DeleteCert

Deletes a CA certificate.

Go debug

Enabling or Disabling a CA Certificate

hcloud Workspace SetCertStatus

Enables or disables a CA certificate.

Go debug

Exporting the PEM File of a CA Certificate

hcloud Workspace ExportCertPemFile

Exports the PEM file of a CA certificate.

Go debug

Exporting the CRL File of a CA Certificate

hcloud Workspace ExportCertCrlFile

Exports the CRL file of a CA certificate.

Go debug

Exporting a CSR of a CA Certificate

hcloud Workspace ExportCertCsrFile

Exports a Certificate Signing Request (CSR) of a CA certificate.

Go debug

Importing a CA Certificate

hcloud Workspace ImportCert

Imports a CA certificate.

Go debug

Querying Available IP Addresses of a Subnet by Subnet ID

hcloud Workspace ShowAvailableIp

Queries available IP addresses of a subnet by subnet ID.

Go debug

Checking the Sysprep Version

hcloud Workspace CheckSysprepInfo

Checks the Sysprep version.

Go debug

Verifying a Desktop Image

hcloud Workspace CheckDesktopImages

Checks whether the desktop image of a specified desktop exists. If the desktop image exists, the corresponding image ID is returned; otherwise, no image ID is returned.

Go debug

Checking Whether Desktops Are Added to a Domain in Batches

hcloud Workspace BatchCheckDesktopRejoinDomain

Checks whether desktops can be added to an AD domain again in batches.

Go debug

Exporting a Desktop List

hcloud Workspace ExportDesktopListNew

Exports the desktop list to an Excel file.

Go debug

Listing Desktops

hcloud Workspace ListDesktops

Queries desktop VMs.

Go debug

Creating a Desktop

hcloud Workspace CreateDesktop

Creates and assigns a desktop to a user. After the desktop is created, the user can log in to the desktop.

Go debug

Querying Details About a Desktop

hcloud Workspace ShowDesktopDetail

Queries details about a specified desktop by ID.

Go debug

Modifying a Desktop Attribute

hcloud Workspace UpdateDesktop

Modifies a desktop attribute.

Go debug

Deleting a Desktop

hcloud Workspace DeleteDesktop

Deletes one desktop. The deleted desktop cannot be restored.

Go debug

Batch Deleting Desktops

hcloud Workspace BatchDeleteDesktops

Deletes desktops in batches. The deleted desktops cannot be restored.

Go debug

Deregistering Desktops in Batches

hcloud Workspace BatchLogoffDesktops

Deregister desktops in batches.

Go debug

Querying the Desktop Details List

hcloud Workspace ListDesktopsDetail

Queries the desktop details list.

Go debug

Performing Operations on a Desktop

hcloud Workspace BatchRunDesktops

Starts, shuts down, hibernates, and restarts desktops in batches.

Go debug

Changing Specifications

hcloud Workspace ResizeDesktop

Only the CPU and memory can be modified. The disks cannot be changed, and the specifications can only be changed to different ones.

Go debug

Rebuilding a Desktop

hcloud Workspace BatchRebuildDesktopsSystemDisk

Recomposes desktop system disks in batches.

Go debug

Querying Desktop Power-On/Off Data

hcloud Workspace ListDesktopActions

Queries desktop power-on/off data.

Go debug

Querying Desktop Monitoring Data

hcloud Workspace ShowDesktopMonitorData

Queries data (such as the CPU usage, memory usage, and period when a user is online) of a desktop in a time range (from 1 hour to 30 days). The data can be retained for up to 180 days.

Go debug

Remotely Logging In to the Console

hcloud Workspace ShowRemoteConsoleAddress

Obtains the address for remotely logging in to the console.

Go debug

Updating a Desktop SID

hcloud Workspace UpdateDesktopSids

If the desktop SID is different from the SID of the Windows AD, update the desktop SID to make both SIDs the same. This API is used when the desktop is not in the domain.

Go debug

Rejoining a Desktop to the AD Domain

hcloud Workspace RegisterDomain

Rejoins a Windows desktop to the AD domain. This API is used when the desktop is not in the domain.

Go debug

Converting a Desktop to an Image

hcloud Workspace ChangeDesktopToImage

Converts a desktop to an image.

Go debug

Unbinding Users in Batches

hcloud Workspace BatchDetachInstances

Unbinds desktops from users in batches.

Go debug

Unbinding a User

hcloud Workspace DetachInstances

Unbinds a desktop from a user.

Go debug

Assigning a Desktop to a User

hcloud Workspace AttachInstances

Assigns a desktop to a user.

Go debug

Modifying User Permission Groups in Batches

hcloud Workspace ChangeUserPrivilegeGroup

Modifies user permission groups in batches.

Go debug

Querying the Desktop Network

hcloud Workspace ShowDesktopNetwork

Queries desktop VPCs, subnets, private IP addresses, EIPs, and security groups.

Go debug

Switching a Desktop Network

hcloud Workspace ChangeDesktopNetwork

Switches the desktop VPC, subnet, IP address, or security group.

Go debug

Querying Desktop Networks in Batches

hcloud Workspace ShowDesktopNetworks

Queries desktop VPCs, subnets, private IP addresses, EIPs, and security groups.

Go debug

Switching Desktop Networks in Batches

hcloud Workspace BatchChangeDesktopNetwork

Switches desktop VPCs, subnets, IP addresses, and security groups in batches.

Go debug

Querying Desktop Unbinding Information

hcloud Workspace ListDesktopDetachInfo

Queries desktop unbinding information.

Go debug

Querying the Sysprep Version

hcloud Workspace ShowSysprepInfo

Queries the Sysprep version.

Go debug

Setting the Desktop Maintenance Mode in Batches

hcloud Workspace SetMaintenanceMode

Sets the desktop administrator maintenance mode in batches.

Go debug

Pre-Assigning Desktops to Users in Batches

hcloud Workspace BatchAssociateInstances

Pre-assigns desktops to users in batches.

Go debug

Assigning Desktops to Users in Batches

hcloud Workspace BatchAttachInstances

Assigns desktops to users in batches.

Go debug

Changing the Associated Username of a Desktop in the AD Scenario

hcloud Workspace UpdateDesktopUsername

Changes the associated username of a desktop in the AD scenario.

Go debug

Sending a Notification

hcloud Workspace SendNotifications

The administrator sends a notification to a desktop.

Go debug

Querying Monitoring Plug-in Installation Details

hcloud Workspace ListAgentsInstallCondition

Queries the details about the installation of monitoring plug-ins on a desktop.

Go debug

Installing Monitoring Plug-ins

hcloud Workspace BatchInstallAgent

Installs monitoring plug-ins on desktops in batches.

Go debug

Querying Remote Assistance Data by Desktop ID

hcloud Workspace ShowDesktopRemoteAssistanceInfo

Queries remote assistance data by desktop ID.

Go debug

Creating Remote Assistance

hcloud Workspace CreateRemoteAssistance

Creates remote assistance.

Go debug

Canceling Remote Assistance

hcloud Workspace CancelRemoteAssistance

Cancels remote assistance.

Go debug

Querying Desktop Connection Statuses

hcloud Workspace ListDesktopsConnectStatus

Queries desktop connection statuses.

Go debug

Querying Desktop Version Statistics

hcloud Workspace ListDesktopStatisticsByVersion

Queries the number of desktops in each desktop version. The desktops can be filtered by version number.

Go debug

Listing Desktops of a Version

hcloud Workspace ListDesktopVersion

Lists desktops by agent version, OS type, desktop name, and username. The query supports pagination.

Go debug

Exporting Desktops of a Version

hcloud Workspace ExportDesktopVersionList

Exports the list of desktops to an Excel file based on the agent version number, OS type, desktop name, and username.

Go debug

Adding Desktops to an AD Domain Again in Batches

hcloud Workspace BatchUpdateDesktopDomain

Adds Windows desktops to an AD domain again. This API is used when the desktops are not in the domain.

Go debug

Querying Hibernation Type

hcloud Workspace ShowHibernateType

Queries the hibernation type.

Go debug

Querying Desktop Pools

hcloud Workspace ListDesktopPools

Query desktop pools.

Go debug

Creating a Desktop Pool

hcloud Workspace CreateDesktopPool

Creates and assigns a desktop pool to a user or user group. When the user logs in, the user is bound to one of the desktops.

Go debug

Querying Desktop Pool Details

hcloud Workspace ShowDesktopPoolDetail

Query details about a specified desktop pool by ID.

Go debug

Modifying Desktop Pool Attributes

hcloud Workspace UpdateDesktopPool

Modify desktop pool attributes.

Go debug

Deleting a Desktop Pool

hcloud Workspace DeleteDesktopPool

If no desktop exists in a desktop pool, you can delete the desktop pool. The deleted desktop pool cannot be restored.

Go debug

Expanding the Desktop Pool Capacity

hcloud Workspace ExpandDesktopPool

Expand the desktop pool capacity.

Go debug

Binding a User to a Desktop Pool

hcloud Workspace AttachDesktopPoolUser

Binds a user to a desktop pool.

Go debug

Changing Desktop Pool Specifications

hcloud Workspace ResizeDesktopPool

Modifies desktop pool specifications.

Go debug

Rebuilding the System Disk of a Desktop Pool

hcloud Workspace RebuildDesktopPool

Recompose the system disk of a desktop pool.

Go debug

Adding Disks in Batches to the Desktop Pool

hcloud Workspace AddDesktopPoolVolumes

Add disks in batches to the desktop pool.

Go debug

Deleting Disks in Batches from the Desktop Pool

hcloud Workspace DeleteDesktopPoolVolumes

Delete disks in batches from the desktop pool.

Go debug

Batch Expanding Disk Capacity in a Desktop Pool

hcloud Workspace ExpandDesktopPoolVolumes

Expand the capacity of disks in batches in the desktop pool.

Go debug

Performing Operations on a Desktop Pool

hcloud Workspace ExecuteDesktopPoolAction

Start, stop, restart, and hibernate desktops in batches in a desktop pool.

Go debug

Querying Users and User Groups Authorized by the Desktop Pool

hcloud Workspace ListDesktopPoolAuthorizedObjects

Query users and user groups authorized by a specified desktop pool.

Go debug

Authorizing Users and User Groups for a Desktop Pool

hcloud Workspace CreateDesktopPoolAuthorizedObjects

Query users and user groups authorized by a desktop pool.

Go debug

Querying Difference Statistics of a Desktop Pool

hcloud Workspace ListInconsistentStatics

Queries the differences between desktops in a desktop pool.

Go debug

Querying Desktop Information in a Desktop Pool

hcloud Workspace ListPoolDesktopsDetail

This interface is used to query desktop information in a desktop pool.

Go debug

Querying the Script Execution Task List of a Desktop Pool

hcloud Workspace ShowDesktopPoolsScriptExecTasks

Desktop pool script execution task list.

Go debug

Executing Desktop Pool Scripts in Batches

hcloud Workspace ExecuteDesktopPoolScript

Desktop pool scripts executed in batches.

Go debug

Sending a Notification

hcloud Workspace SendDesktopPoolNotifications

The administrator sends a notification to a desktop.

Go debug

Listing Associated Desktop Pools

hcloud Workspace ListDesktopPoolsByUsers

Lists desktop pools associated with a user.

Go debug

Listing Desktop Naming Policies

hcloud Workspace ListDesktopNamePolicy

Policy for obtaining desktop names, which is used to automatically generate desktop names.

Go debug

Creating a Desktop Name Policy

hcloud Workspace CreateDesktopNamePolicy

Creates a desktop name policy to automatically generate desktop names.

Go debug

Updating the Desktop Name Policy

hcloud Workspace UpdateDesktopNamePolicy

Update the desktop name policy to automatically generate desktop names.

Go debug

Deleting Desktop Name Policies in Batches

hcloud Workspace BatchDeleteDesktopNamePolicy

This interface is used to delete desktop name policies in batches.

Go debug

Querying Desktop Tags

hcloud Workspace ShowTagByDesktopId

Queries the tag information of a specified desktop.

Go debug

Creating a Desktop Tag

hcloud Workspace CreateTag

Creates tags for a desktop. A desktop can have a maximum of 10 tags. If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one.

Go debug

Deleting a Desktop Tag

hcloud Workspace DeleteTag

Deletes a desktop tag. If the tag to be deleted does not exist, the deletion is considered successful.

Go debug

Querying Project Tags

hcloud Workspace ListProjectTags

Queries all tags of a tenant.

Go debug

Batch Adding or Deleting Tags

hcloud Workspace BatchChangeTags

Adds or deletes tags in batches for a specified desktop. If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one. If the tag to be deleted does not exist, the deletion is considered successful.

Go debug

Filtering Desktops by Tag (Deprecated)

hcloud Workspace ListDesktopByTags

Filters desktops by tag. This API has been deprecated. Use post /v2/{project_id}/desktops/resource-instances/action instead.

Go debug

Filtering Desktops by Tag

hcloud Workspace ListDesktopsByTags

Filters desktops by tag.

Go debug

Adding Multiple Desktop Tags in Batches

hcloud Workspace BatchAddDesktopsTags

Tags can be added to multiple desktops in batches. If the tags to be created already exist (with the same key), the tags will be overwritten by default. The operation can be performed on a maximum of 100 desktops, and a maximum of 20 tags are allowed for each desktop.

Go debug

Deleting Multiple Desktop Tags in Batches

hcloud Workspace BatchDeleteDesktopsTags

Tags can be deleted from multiple desktops in batches. If the tags to be deleted do not exist, the deletion is considered successful by default. The operation can be performed on a maximum of 100 desktops, and a maximum of 20 tags are allowed for each desktop.

Go debug

Purchasing Auxiliary Resources for Desktops

hcloud Workspace AddDesktopSubResources

Purchases depended resources of an existing desktop.

Go debug

Deleting Auxiliary Resources from the Desktop

hcloud Workspace DeleteDesktopSubResources

Deletes depended resources of a desktop.

Go debug

Exporting Users

hcloud Workspace ExportUsersNew

Exports users in an Excel file.

Go debug

Querying Users

hcloud Workspace ListUsers

Queries desktop users.

Go debug

Creating a User

hcloud Workspace CreateDesktopUser

Creates a Workspace user.

Go debug

Querying User Details

hcloud Workspace ListUserDetail

Queries details about a specified desktop user.

Go debug

Modifying User Information

hcloud Workspace UpdateUserInfo

Modifies desktop user information.

Go debug

Deleting a Specified User

hcloud Workspace DeleteUser

Deletes a specified desktop user.

Go debug

Deleting Users in Batches

hcloud Workspace BatchDeleteUser

Deletes desktop users in batches.

Go debug

Downloading a User Template

hcloud Workspace ExportUserListTemplate

Downloads a user template.

Go debug

Creating a User Template Download Task

hcloud Workspace ExportUsersTemplate

Creates a user template download task.

Go debug

Creating Users in Batches

hcloud Workspace BatchCreateUsers

Creates users in batches.

Go debug

Importing the User List

hcloud Workspace ImportUserList

Imports the user list.

Go debug

Performing User-related Operations

hcloud Workspace ChangeUserStatus

Performs user-related operations, including locking and unlocking a user, and resetting the password. You are advised to use the API /v2/{project_id}/users/{user_id}/random-password to reset the password. If no notification method is available, the API /v2/{project_id}/users/{user_id}/random-password must be used.

Go debug

Resetting a Random Password for a User

hcloud Workspace ResetRandomPassword

Resets the password for a user.

Go debug

Querying OTP Devices

hcloud Workspace ListOtpDevicesByUserId

Queries OTP devices of a user.

Go debug

Unbinding an OTP Device

hcloud Workspace BatchDeleteOtpDevices

Unbinds an OTP device from a user.

Go debug

Resending an Email

hcloud Workspace SendEmail

Resends an email.

Go debug

Querying Notification Blocking Records

hcloud Workspace ListNotificationRecords

Queries notification blocking records.

Go debug

Querying User Groups

hcloud Workspace ListUserGroups

Query user groups. Pagination is supported.

Go debug

Creating a User Group

hcloud Workspace CreateUserGroup

Create a user group.

Go debug

Deleting User Groups in Batches

hcloud Workspace BatchDeleteUserGroups

Delete user groups in batches.

Go debug

Modifying User Group Information

hcloud Workspace UpdateUserGroup

Modify user group information.

Go debug

Deleting a User Group

hcloud Workspace DeleteUserGroup

Deletes a user group.

Go debug

Performing Operations on a User Group

hcloud Workspace RunActionsOnGroup

Perform operations on user groups, such as adding and deleting users.

Go debug

Querying Users in a User Group

hcloud Workspace ListUsersOfGroup

Query users in a user group.

Go debug

Exporting a User Group

hcloud Workspace ExportUserGroupsNew

Exports a user group in an Excel file.

Go debug

Exporting Users in a User Group

hcloud Workspace ExportUserGroupUsersNew

Exports users in a user group in an Excel file.

Go debug

Exporting a User Group

hcloud Workspace ExportUserGroups

Exports a user group in an Excel file.

Go debug

Querying OUs

hcloud Workspace ListOuDetails

Queries OUs.

Go debug

Adding OU Information

hcloud Workspace AddOu

Creates an OU.

Go debug

Updating OU Information

hcloud Workspace UpdateOuInfo

Updates OU information.

Go debug

Deleting OU Information

hcloud Workspace DeleteOu

Deletes OU information.

Go debug

Querying OUs in the AD Domain

hcloud Workspace ListAdOus

Queries OUs in the AD domain.

Go debug

Querying Users in an OU

hcloud Workspace ListAdOuUsers

Queries users in an OU.

Go debug

Adding a Desktop Disk

hcloud Workspace AddDesktopVolumes

Adds disks to a single desktop.

Go debug

Deleting a Data Disk from a Desktop

hcloud Workspace DeleteDesktopVolumes

Deletes a data disk from the desktop. The deleted data disk cannot be restored.

Go debug

Adding Desktop Disks in Batches

hcloud Workspace AddVolumes

Adds desktop disks in batches.

Go debug

Expanding Disk Capacity

hcloud Workspace ExpandDesktopVolume

Expands disk capacity.

Go debug

Expanding the Disk Capacity of a Desktop

hcloud Workspace ExpandVolumes

Expands the disk capacity of a desktop.

Go debug

Batch Modifying Disk QoS Configurations

hcloud Workspace BatchModifyQosVolumes

Modifies disk QoS configurations in batches.

Go debug

Querying Disk Product Information

hcloud Workspace ListVolumeProductInfo

Queries disk product information.

Go debug

Creating Snapshots in Batches

hcloud Workspace BatchCreateDesktopSnapshot

Creates snapshots in batches.

Go debug

Deleting Snapshots in Batches

hcloud Workspace BatchDeleteDesktopSnapshot

Deletes snapshots in batches.

Go debug

Restoring Snapshots in Batches

hcloud Workspace BatchRestoreDesktopSnapshot

Restores snapshots in batches.

Go debug

Querying Snapshots

hcloud Workspace ListDesktopSnapshot

Queries snapshots.

Go debug

Querying Desktop Login Statuses

hcloud Workspace ListInstancesStatus

Queries desktop login statuses.

Go debug

Exporting Connection Records (To Be Deprecated)

hcloud Workspace ExportUserLoginInfoNew

Exports connection records. This API will be deprecated.

Go debug

Querying the Number of Login Users

hcloud Workspace ListHistoryOnlineInfoNew

Queries the number of login users. All query parameters cannot be left empty.

Go debug

Querying Login Information

hcloud Workspace ListLoginRecordsNew

Queries login information.

Go debug

Exporting Connection Records

hcloud Workspace ExportUserConnectionNew

Exports connection records.

Go debug

Querying Policy Group Brief Information

hcloud Workspace ListPolicyGroup

Queries brief information of a policy group, excluding policy information and application object information.

Go debug

Adding a Policy Group

hcloud Workspace CreatePolicyGroup

Adds a policy group.

Go debug

Querying Policy Group Details

hcloud Workspace ListPolicyDetailInfoById

Queries details about a policy group by policy group ID, including the policy information and application object information.

Go debug

Modifying a Policy Group

hcloud Workspace UpdatePolicyGroup

Modifies information about a specified policy group.

Go debug

Deleting a Policy Group

hcloud Workspace DeletePolicyGroup

Deletes a specified policy group, including the policy information and application object information of the policy group.

Go debug

Exporting a Policy Group

hcloud Workspace ExportPolicyGroups

Exports a policy group in XML format.

Go debug

Querying Policy Items of a Policy Group

hcloud Workspace ListPoliciesOfPolicyGroup

Queries policy items of a specified policy group.

Go debug

Modifying Policy Items of a Policy Group

hcloud Workspace UpdatePoliciesOfPolicyGroup

Modifies some or all policy items of a policy group.

Go debug

Querying Objects to Which a Policy Group Is Applied

hcloud Workspace ListTargetOfPolicyGroup

Queries objects to which a policy group is applied.

Go debug

Modifying Objects to Which a Policy Group Is Applied

hcloud Workspace BatchUpdateTargetOfPolicyGroup

Batch adds or deletes objects to which a policy group is applied.

Go debug

Querying Policy Group Details

hcloud Workspace ListPolicyGroupInfo

Policy information and object information.

Go debug

Querying Initial Policy Items

hcloud Workspace ListOriginalPolicyInfo

Queries initial policy items.

Go debug

Creating a Policy Template

hcloud Workspace CreatePolicyTemplate

Creates a policy template.

Go debug

Importing a Policy Group

hcloud Workspace ImportPolicyGroups

Imports a policy group in XML format.

Go debug

Listing Access Policies

hcloud Workspace ListAccessPolicies

Queries an access policy.

Go debug

Creating an Access Policy

hcloud Workspace CreateAccessPolicy

Creates an access policy.

Go debug

Deleting an Access Policy

hcloud Workspace BatchDeleteAccessPolicies

Deletes a specified access policy.

Go debug

Updating a Specified Access Policy

hcloud Workspace UpdateAccessPolicy

Updates a specified access policy.

Go debug

Listing Objects to Which a Specified Access Policy Is Applied

hcloud Workspace ListAccessPolicyObjects

Queries the object to which a specified access policy is applied.

Go debug

Updating Objects to Which a Specified Access Policy Is Applied

hcloud Workspace UpdateAccessPolicyObjects

Updates the object to which a specified access policy is applied.

Go debug

Importing an IP Address List

hcloud Workspace ImportIp

Imports an IP address list in Excel format.

Go debug

Downloading an Imported IP Address Template

hcloud Workspace ExportIpTemplate

Downloads an imported IP address template.

Go debug

Exporting a Terminal-Desktop Binding Excel

hcloud Workspace ExportTerminalsBindingDesktopsInfoNew

Exports information about terminal-desktop binding to an Excel file.

Go debug

Querying the Switch Configuration About Terminal-Desktop Binding

hcloud Workspace ListTerminalsBindingDesktopsConfig

Queries the configuration of the switch for binding a terminal to a desktop.

Go debug

Setting the Terminal-Desktop Binding Switch

hcloud Workspace UpdateTerminalsBindingDesktopsConfig

Configures the switch for binding a terminal to a desktop.

Go debug

Listing Terminal-Desktop Binding Configurations

hcloud Workspace ListTerminalsBindingDesktops

Queries the configuration list of terminal-desktop binding.

Go debug

Adding Terminal-Desktop Binding Configurations

hcloud Workspace CreateTerminalsBindingDesktops

Adds a terminal-desktop binding configuration.

Go debug

Modifying Terminal-Desktop Binding Configurations

hcloud Workspace UpdateTerminalsBindingDesktops

Modifies a terminal-desktop binding configuration.

Go debug

Deleting Terminal-Desktop Binding Configurations

hcloud Workspace DeleteTerminalsBindingDesktops

Deletes a terminal-desktop binding configuration.

Go debug

Downloading a Template for Terminal-Desktop Binding

hcloud Workspace ExportTerminalsBindingDesktopsTemplate

Downloads a template for terminal-desktop binding.

Go debug

Querying Desktops of a Workspace Host

hcloud Workspace ListServersByHostId

Queries desktops of a Workspace host. This API is provided for the console.

Go debug

Listing Workspace Hosts

hcloud Workspace ListHostsDetail

Lists Workspace hosts.

Go debug

Updating a Workspace Host

hcloud Workspace UpdateHosts

Updates the Workspace host information by host ID. This API is provided for the console and Xsuperzone.

Go debug

Exporting the Workspace Host List

hcloud Workspace ExportHostsDetail

Exporting Details About the Workspace Host List

Go debug

Placing a Yearly/Monthly Order

hcloud Workspace CreateOrder

Places an order for yearly/monthly resources, including desktops, disks.

Go debug

Changing an Order

hcloud Workspace CreateChangeOrder

Changes specifications, expands disk capacity.

Go debug

Batch Changing Orders of Yearly/Monthly Desktops

hcloud Workspace CreateDesktopBatchOrder

Changes yearly/monthly desktop orders in batches.

Go debug

Querying the Price for Changing the Images of Yearly/Monthly Desktops in Batches

hcloud Workspace EstimateChangeImages

Queries the price for changing the images of yearly/monthly desktops in batches, from free images to paid ones.

Go debug

Batch Changing Orders of a Yearly/Monthly Desktop Pool

hcloud Workspace CreateDesktopPoolChangeOrder

Changes yearly/monthly desktop pool orders in batches.

Go debug

Querying the Price for Adding a Single Disk to Yearly/Monthly Desktop Pools in Batches

hcloud Workspace EstimateDesktopPoolAddVolume

Queries the price for adding a single disk to yearly/monthly desktop pools in batches.

Go debug

Querying the Price for Changing the Images of Yearly/Monthly Desktop Pools in Batches

hcloud Workspace EstimateDesktopPoolChangeImage

Queries the price for changing the images of yearly/monthly desktop pools in batches, from free images to paid ones.

Go debug

Querying the Price for Expanding Disk Capacity of Yearly/Monthly Desktop Pools in Batches

hcloud Workspace EstimateDesktopPoolExtendVolume

Queries the price for expanding disk capacity of yearly/monthly desktop pools in batches.

Go debug

Querying the Price for Changing the Specifications of Yearly/Monthly Desktop Pools in Batches

hcloud Workspace EstimateDesktopPoolResize

Queries the price for changing the specifications of yearly/monthly desktop pools in batches.

Go debug

Querying the Price for Increasing the Specifications of Yearly/Monthly Desktops in Batches

hcloud Workspace EstimateAddResources

Queries the price for increasing the specifications of yearly/monthly desktops in batches.

Go debug

Placing an Order on Changing the Bandwidth of Yearly/Monthly Workspace

hcloud Workspace CreateSubnetBandwidthChangeOrder

Places an order on changing the bandwidth of yearly/monthly Workspace.

Go debug

Creating a Desktop Order

hcloud Workspace CreateDesktopOrder

Creates a desktop order.

Go debug

Creating a Resource Package Order

hcloud Workspace CreateResourcePackagesOrder

Creates a resource package order.

Go debug

Querying the Product Package List

hcloud Workspace ListProducts

Query the product packages supported by Huawei Cloud Workspace.

Go debug

Querying Hourly Package Types That Can Be Subscribed To

hcloud Workspace ListHourPackagesType

Queries hourly package types that can be subscribed to.

Go debug

Querying the Collaboration Package List

hcloud Workspace ListSharerProducts

This interface is used to query the collaboration package list.

Go debug

Listing Pay-per-Use Resource Packages

hcloud Workspace ListResourcePackages

Lists pay-per-use resource packages.

Go debug

Querying Screen Recording Records

hcloud Workspace ListScreenRecords

Queries screen recording records.

Go debug

Querying Screen Recording Details

hcloud Workspace ShowScreenRecord

Queries screen recording details.

Go debug

Updating Full-Speed Screen Recording Upload Details

hcloud Workspace UpdateScreenRecords

Updates the full-speed screen recording upload details.

Go debug

Deleting Screen Recording Records in Batches

hcloud Workspace BatchDeleteScreenRecords

Deletes screen recording records in batches.

Go debug

Querying Download Addresses

hcloud Workspace ListDownloadAddress

Queries download addresses.

Go debug

Querying Key Desktop Events

hcloud Workspace ListDesktopOperations

Queries key desktop events.

Go debug

Querying the Screen Recording Traffic Limit Configuration of a Site

hcloud Workspace ListScreenRecordsTrafficLimitConfig

Queries the screen recording traffic limit configuration of a site.

Go debug

Updating the Screen Recording Traffic Limit Configuration of a Site

hcloud Workspace UpdateScreenRecordsTrafficLimitConfig

Updates the screen recording traffic limit configuration of a site.

Go debug

Querying Scheduled Tasks

hcloud Workspace ListScheduledTasks

Query scheduled tasks.

Go debug

Creating a Scheduled Task

hcloud Workspace CreateScheduledTasks

Creates a scheduled task.

Go debug

Querying Details About a Scheduled Task

hcloud Workspace ShowScheduledTasks

Query details about a scheduled task.

Go debug

Modifying a Scheduled Task

hcloud Workspace UpdateScheduledTasks

Modify a scheduled task.

Go debug

Deleting a Scheduled Task

hcloud Workspace DeleteScheduledTasks

Delete a scheduled task.

Go debug

Listing Future Execution Times

hcloud Workspace ListFutureExecutions

List of future execution time.

Go debug

Deleting Scheduled Tasks in Batches

hcloud Workspace BatchDeleteScheduledTasks

Delete scheduled tasks in batches.

Go debug

Querying the Execution Records of a Scheduled Task

hcloud Workspace ListScheduledTasksRecords

Query the execution records of a scheduled task.

Go debug

Querying Details About Scheduled Task Execution Records

hcloud Workspace ListScheduledTasksRecordsDetails

Query details about scheduled task execution records.

Go debug

Exporting Records and Execution Details of a Scheduled Task

hcloud Workspace ExportScheduledTasksRecords

Exports the records and execution details of a scheduled task.

Go debug

Querying Lifecycle Type Configurations

hcloud Workspace ListLifeCycleTypeConfigurations

Queries the Apollo configuration item life.cycle.type.action based on the type to obtain the corresponding configuration information. If type is not transferred, all configuration items are returned.

Go debug

Obtaining Time Zone Configurations

hcloud Workspace ListTimeZones

Obtains time zone configurations.

Go debug

Listing Export Tasks

hcloud Workspace ListExportTasks

Lists export tasks.

Go debug

Batch Deleting Export Tasks

hcloud Workspace DeleteExportTasks

Batch deletes export tasks.

Go debug

Downloading an Exported File

hcloud Workspace DownloadExportFile

Downloads an exported file.

Go debug

Querying Desktop Statistics

hcloud Workspace ListDesktopsStatistics

Statistics on the statuses of general desktops and desktop pools of a tenant. By default, only the total number is collected.

Go debug

Running Status Statistics

hcloud Workspace ListRunState

Statistics on the running statuses of tenant desktops.

Go debug

Querying Login Status Statistics

hcloud Workspace ListLoginState

Statistics on the login statuses of tenant desktops.

Go debug

Querying Desktops That Are Not Used in a Specified Period

hcloud Workspace ListUnusedDesktops

Queries desktops that are idle in a specified period. This API has been discarded and is not recommended. You are advised to use the APIs for querying desktop usage statistics and querying user usage statistics.

Go debug

Querying the Desktop Usage Duration

hcloud Workspace ListUsedDesktopInfo

Queries desktop usage duration. This API has been discarded and is not recommended. You are advised to use the APIs for querying desktop usage statistics and querying user usage statistics.

Go debug

Querying Period-on-Period Metrics

hcloud Workspace ShowGrowthRate

Queries period-on-period metrics.

Go debug

Querying Metrics

hcloud Workspace ListMetrics

Queries metrics.

Go debug

Querying Metric Trends

hcloud Workspace ListMetricsTrend

Queries metric trends.

Go debug

Updating a Notification Rule

hcloud Workspace UpdateMetricNotifyRule

Updates notification rules of the corresponding metric. A notification is sent when the rules are met.

Go debug

Deleting a Notification Rule

hcloud Workspace DeleteMetricNotifyRule

Deletes notification rules of the corresponding metric. A notification is sent when the rules are met.

Go debug

Querying Notification Rules

hcloud Workspace ListMetricNotifyRule

Queries notification rules of the corresponding metric.

Go debug

Adding a Notification Rule

hcloud Workspace AddMetricNotifyRule

Adds notification rules of the corresponding metric. A notification is sent when the rules are met.

Go debug

Querying Whether There Are Records That Meet the Notification Rule in the Corresponding Metric Dimension

hcloud Workspace ListMetricNotifyRecord

Queries whether there are records that meet the notification rule in the corresponding metric dimension.

Go debug

Querying Desktop Usage Statistics

hcloud Workspace ListDesktopUsageMetric

Queries desktop usage statistics.

Go debug

Querying User Usage Statistics

hcloud Workspace ListUserUsageMetric

Queries user usage statistics.

Go debug

Querying Access Statistics of Application Streaming

hcloud Workspace ListAppUserAccessData

Query statistics about Application Streaming access. You can query data of a maximum of 30 days at a time, and data of the past 30 days.

Go debug

Exporting Access Statistics of Application Streaming

hcloud Workspace ExportAppUserAccessData

Creates a task of exporting access statistics of Application Streaming. Only data of the last 30 days can be exported. After the task is created, call the ListExportTasks API to query the task status by task ID and call the DownloadExportFile API to download the exported file.

Go debug

Querying Duration Data of Each Phase of Workspace or Application Streaming

hcloud Workspace ShowUserAccessStages

Queries duration data of each phase of Workspace or Application Streaming.

Go debug

Exporting Desktop Usage Statistics

hcloud Workspace ExportDesktopUsageMetricNew

Exports desktop usage statistics.

Go debug

Exporting User Usage Statistics

hcloud Workspace ExportUserUsageMetricNew

Exports user usage statistics.

Go debug

Querying User Events

hcloud Workspace ListUserEvents

Queries user events. You can query data of a maximum of 30 days at a time, and data of the past 30 days.

Go debug

Querying the LTS Configuration of User Events

hcloud Workspace ListUserEventsLtsConfigurations

Queries the LTS configuration of user events.

Go debug

Configuring LTS for User Events

hcloud Workspace SetUserEventsLtsConfigurations

Configures LTS for user events.

Go debug

Querying Scripts

hcloud Workspace ListScripts

Queries scripts.

Go debug

Adding a Script

hcloud Workspace CreateScript

Adds a script.

Go debug

Querying Script Details

hcloud Workspace ShowScriptDetail

Queries script details.

Go debug

Updating a Script

hcloud Workspace UpdateScript

Updates a script.

Go debug

Deleting a Script

hcloud Workspace DeleteScript

Deletes a script.

Go debug

Executing Scripts or Commands in Batches

hcloud Workspace ExecuteScriptOrCommand

Executes scripts or commands in batches.

Go debug

Querying Script Execution Record Details

hcloud Workspace ShowScriptRecordDetail

Queries script execution record details.

Go debug

Querying Script Execution Records

hcloud Workspace ListScriptRecords

Queries script execution records.

Go debug

Querying Script Tasks

hcloud Workspace ListScriptTasks

Queries script tasks.

Go debug

Retrying a (Failed) Script Execution Task

hcloud Workspace RetryScriptExecution

Retries a (failed) script execution task.

Go debug

Stopping a Script or Command Execution Task

hcloud Workspace StopScriptExecution

Stops a script or command execution task.

Go debug

Delivering and Executing Scripts or Commands by Desktop Tag

hcloud Workspace ExecuteScriptByDesktopTag

Delivers and executes scripts or commands by desktop tag.

Go debug

Querying Resource Quotas

hcloud Workspace ShowQuotas

Console Framework and WKSDesktopManager call this API to query tenant quotas.

Go debug

Querying Tenant Quota Details of a Single Site

hcloud Workspace ShowQuotaDetails

Queries tenant quota details of a single site.

Go debug

Obtaining KooGallery Images

hcloud Workspace ListMarketImages

Obtains KooGallery images.

Go debug

Listing Product Images

hcloud Workspace ListImages

Queries the product images supported by Huawei Cloud Workspace.

Go debug

Querying AZs

hcloud Workspace ListAvailabilityZones

Queries AZs where Huawei Cloud Workspace is available.

Go debug

Querying AZ Summary

hcloud Workspace ListAzs

Queries AZs where Huawei Cloud Workspace is available.

Go debug

Querying AZ Details

hcloud Workspace ShowAzDetails

Queries AZs where Huawei Cloud Workspace is available.

Go debug

Querying Task Details

hcloud Workspace ShowJob

Queries the execution status of an asynchronous task, such as a desktop creation task.

Go debug

Querying Subtasks

hcloud Workspace ListItaSubJobs

Queries the execution status of an asynchronous task, such as a desktop creation task.

Go debug

Deleting a Subtask

hcloud Workspace BatchDeleteSubJobs

Deletes a subtask. Any tasks of the changeAccessVpc, cancelWorkspace, or applyWorkspace type cannot be deleted.

Go debug

Retrying a Task

hcloud Workspace RunActionsOnWorkspaceJob

Retries a failed task. Currently, only registration and deregistration tasks can be retried.

Go debug

Querying Network Access

hcloud Workspace ListInternet

Queries network access.

Go debug

Enabling Network Access

hcloud Workspace ApplyInternet

Enables network access.

Go debug

Querying EIPs Bound to Desktops and Unbound EIPs

hcloud Workspace ListDesktopsEips

Queries EIPs bound to desktops and unbound EIPs.

Go debug

Enabling the Desktop Internet Access Function

hcloud Workspace ApplyDesktopsInternet

Enable the desktop Internet access function.

Go debug

Binding an EIP to a Desktop

hcloud Workspace AssociateDesktopsEip

Bind an EIP to the desktop.

Go debug

Unbinding EIPs from Desktops in Batches

hcloud Workspace BatchDisassociateDesktopsEip

Unbind EIPs from desktops in batches.

Go debug

Querying Subnet IDs in Use

hcloud Workspace ShowUsingSubnets

Queries IDs of subnets in use based on the subnet ID list and returns the subnet ID list.

Go debug

Querying Ports

hcloud Workspace ListPorts

Queries ports.

Go debug

Querying NAT Gateways

hcloud Workspace ListNatGateways

Queries NAT gateways.

Go debug

Querying the Workspace Bandwidth List

hcloud Workspace ListSubnetBandwidths

Queries the Workspace bandwidth list.

Go debug

Creating Workspace Bandwidth

hcloud Workspace ApplySubnetBandwidth

Creates pay-per-use Workspace bandwidth.

Go debug

Modifying Workspace Bandwidth

hcloud Workspace UpdateSubnetBandwidth

Modifies Workspace bandwidth.

Go debug

Deleting Workspace Bandwidth

hcloud Workspace DeleteSubnetBandwidth

Deletes Workspace bandwidth.

Go debug

Querying Workspace Bandwidth Control

hcloud Workspace ShowSubnetBandwidthControlList

Queries Workspace bandwidth control.

Go debug

Modifying Workspace Bandwidth Control

hcloud Workspace UpdateSubnetBandwidthControlList

Modifies Workspace bandwidth control.

Go debug

Listing Security Groups

hcloud Workspace ListSecurityGroups

Lists security groups.

Go debug

Querying VPCs

hcloud Workspace ListVpcInfo

Queries VPCs.

Go debug

Listing Subnets

hcloud Workspace ListSubnets

Lists subnets.

Go debug

Verifying Conflicting Network Segments of a Tenant

hcloud Workspace CheckCidr

Checks whether tenant network segments conflict with each other and returns the list of conflicting network segments.

Go debug

Querying an Agency

hcloud Workspace ListAgencies

Queries agencies.

Go debug

Enabling Agency

hcloud Workspace CreateAgencies

Enables agency.

Go debug

Generating Access Credential Information

hcloud Workspace CreateBucketCredential

Generates bucket credential information.

Go debug

Adding and Authorizing Access to a Default Bucket

hcloud Workspace CreateAndAuthorizeBucket

Adds and authorizes access to a default bucket. If there is no bucket, a bucket is automatically created.

Go debug

Querying Applications by Name in Pagination Mode

hcloud Workspace ListApps

Queries applications by name in pagination mode.

Go debug

Adding an Application

hcloud Workspace UploadApp

Adds an application.

Go debug

Deleting an Application

hcloud Workspace DeleteApp

Deletes an application.

Go debug

Modifying an Application

hcloud Workspace UpdateUploadedApp

Modifies an application.

Go debug

Automatically Installing an Application

hcloud Workspace InstallApp

Automatically installs an application (silent installation or installation after decompression).

Go debug

Querying Application Authorization

hcloud Workspace ListAppAuthorizations

Queries application authorization.

Go debug

Assigning Application Authorization

hcloud Workspace UpdateAppAuthorizations

Assigns application authorization.

Go debug

Deleting Applications in Batches

hcloud Workspace BatchDeleteApps

Deletes applications in batches.

Go debug

Setting Invisibility for Applications in Batches

hcloud Workspace BatchDisableApps

Sets invisibility for applications in batches.

Go debug

Setting Visibility for Applications in Batches

hcloud Workspace BatchEnableApps

Sets visibility for applications in batches.

Go debug

Assigning Application Authorization in Batches

hcloud Workspace BatchUpdateAppAuthorizations

Assigns application authorization in batches.

Go debug

Automatically Installing Applications in Batches

hcloud Workspace BatchInstallApps

Automatically installs applications in batches (silent installation or installation after decompression).

Go debug

Querying Application Categories

hcloud Workspace ListAppCatalogs

Queries application categories.

Go debug

Querying Application Installation Jobs

hcloud Workspace ListJobs

Queries application installation jobs.

Go debug

Deleting Jobs in Batches

hcloud Workspace BatchDeleteJobs

Deletes jobs in batches.

Go debug

Retrying a Failed Job

hcloud Workspace RetryJobs

Retries a failed job. (Retrying a job of types other than failed will cause an error to be returned.)

Go debug

Querying Application Rules

hcloud Workspace ListAppRule

Queries application rules.

Go debug

Creating an Application Rule

hcloud Workspace CreateAppRule

Creates an application rule.

Go debug

Deleting an Application Rule

hcloud Workspace DeleteAppRule

Deletes an application rule.

Go debug

Modifying an Application Rule

hcloud Workspace UpdateAppRule

Modifies an application rule.

Go debug

Deleting Rules in Batches

hcloud Workspace BatchDeleteAppRules

Deletes rules in batches.

Go debug

Enabling Rule-based Management

hcloud Workspace EnableRuleRestriction

Enables rule-based management.

Go debug

Disabling Rule-based Management

hcloud Workspace DisableRuleRestriction

Disables rule-based management.

Go debug

Querying Control Rules

hcloud Workspace ShowRuleRestriction

Queries control rules.

Go debug

Setting a Control Rule

hcloud Workspace SetRuleRestriction

Sets a control rule.

Go debug

Querying Management Rules

hcloud Workspace ListRestrictedRule

Queries management rules.

Go debug

Adding a Management Rule

hcloud Workspace AddRestrictedRule

Adds a management rule.

Go debug

Deleting Control Rules in Batches

hcloud Workspace DeleteRestrictedRule

Deletes control rules in batches.

Go debug

Listing Agent Instances

hcloud Workspace ListAgentInstances

List agent instances. Filtering, sorting, and pagination are supported.

Go debug

Querying the Statistics of Agent Instances

hcloud Workspace ListInstanceStatistics

Queries the statistics of agent instances, including the total number of desktops, number of desktops without models configured, number of desktops without channels configured, and number of risky desktops.

Go debug

Querying Model Groups Associated with an Agent Instance

hcloud Workspace ListInstanceModelGroups

Queries all model groups associated with an agent instance based on the agent instance ID. The model groups are sorted in ascending order by priority and can be displayed on multiple pages.

Go debug

Delivering the IM Channel Configuration

hcloud Workspace SaveImChannels

Configures an IM channel (DingTalk/WeCom/Lark/WeWork).

Go debug

Listing IM Channel Configurations

hcloud Workspace ListImChannels

Lists IM channels configured for an agent instance based on the primary key ID of the agent instance.

Go debug

Deleting an IM Channel Configuration

hcloud Workspace DeleteImChannel

Deletes the IM channel configuration of a platform from a specified agent instance.

Go debug

Associating Model Groups with Resources (Desktops/Desktop Tags) in Batches

hcloud Workspace ApplyModelConfig

Associates model groups with resources in batches. You can associate desktops or desktop tags with model groups, or associate model groups with desktops or desktop tags.

Go debug

Disassociating Model Groups from Resources in Batches

hcloud Workspace RemoveModelConfig

Removes the association between model groups and resources (desktops or desktop tags) in batches.

Go debug

Listing Model Groups

hcloud Workspace ListModelGroups

Lists model groups. Fuzzy search is supported.

Go debug

Adding a Model Group

hcloud Workspace CreateModelGroup

Adds a model group and associates it with a provider.

Go debug

Querying Details About a Model Group

hcloud Workspace ShowModelGroup

Queries details about a model group, including the simplified information about the associated provider.

Go debug

Updating a Model Group

hcloud Workspace UpdateModelGroup

Updates information about a model group.

Go debug

Deleting a Model Group

hcloud Workspace DeleteModelGroup

Deletes a model group. If the model group has been authorized and bound to an agent instance or desktop tag, the model group cannot be deleted. In this case, error 422 is returned.

Go debug

Binding Providers to a Model Group in Batches

hcloud Workspace BatchBindProviders

Binds providers to a specified model group in batches.

Go debug

Listing Application Objects Associated with a Model Group

hcloud Workspace ListModelGroupResources

Queries application objects (agent instances or desktop tags) associated with a model group by page.

Go debug

Listing Providers Associated with a Model Group

hcloud Workspace ListModelGroupProviders

Queries providers associated with a model group by page.

Go debug

Unbinding Providers from a Model Group in Batches

hcloud Workspace BatchDeleteProviders

Unbinds providers in batches. If all providers are unbound, status code 200 is returned. If some providers are unbound, status code 207 is returned.

Go debug

Listing Provider Templates

hcloud Workspace ListProviderTemplates

Obtains the built-in provider template list (hw_maas and deepseek).

Go debug

Verifying a Provider

hcloud Workspace VerifyProvider

Verifies the provider connectivity and API key validity.

Go debug

Listing Remote Models of a Provider

hcloud Workspace ListRemoteProviderModels

Lists available models of a third-party platform based on the provider configuration.

Go debug

Listing Provider Configurations

hcloud Workspace ListProviders

Lists suppliers. Pagination and multi-dimensional filtering are supported.

Go debug

Adding a Provider

hcloud Workspace CreateProvider

Creates a provider. Associated models can also be created in batches.

Go debug

Querying Details About a Provider

hcloud Workspace ShowProvider

Obtains the details about a provider, including the associated group list and subordinate model list.

Go debug

Updating a Provider

hcloud Workspace UpdateProvider

Updates provider information.

Go debug

Deleting a Provider

hcloud Workspace DeleteProvider

Deletes a provider. After the provider is deleted, all model records under the provider are automatically deleted, and the model delivery event is triggered again.

Go debug

Adding Models in Batches

hcloud Workspace BatchCreateModel

Create models in batches. (If the provider already exists, new models will be added.)

Go debug

Deleting Models in Batches

hcloud Workspace BatchDeleteModel

Delete models in batches (partial failure is supported).

Go debug

Listing Models

hcloud Workspace ListModels

Obtains the model list of a specified vendor. Pagination is supported.

Go debug

Obtaining Details About a Model

hcloud Workspace ShowModel

Obtains model details.

Go debug

Updating a Model

hcloud Workspace UpdateModel

Updates model information.

Go debug

Listing Enterprise-developed Skills

hcloud Workspace ListSkills

This API is used to list enterprise-developed skills. Skills can be filtered by category and status.

Go debug

Creating an Enterprise-developed Skill

hcloud Workspace CreateSkill

This API is used to create an enterprise-developed skill and upload the skill package.

Go debug

Querying Details About an Enterprise-developed Skill

hcloud Workspace ShowSkill

This API is used to query details about an enterprise-developed skill, including the skill package summary list.

Go debug

Updating an Enterprise-developed Skill

hcloud Workspace UpdateSkill

This API is used to update enterprise self-developed skill information.

Go debug

Deleting an Enterprise-developed Skill

hcloud Workspace DeleteSkill

This API is used to delete an enterprise-developed skill.

Go debug

Listing Upgrade Policies

hcloud Workspace ListTenantUpgradeStrategies

Lists upgrade policies by page.

Go debug

Exporting the Upgrade Policy List

hcloud Workspace ExportTenantUpgradeStrategies

Asynchronously exports upgrade policy data.

Go debug

Listing Application Objects of an Upgrade Policy

hcloud Workspace ListApplyObjects

Lists application objects of a specified policy by page.

Go debug

Updating Application Objects of an Upgrade Policy in Batches

hcloud Workspace UpdateStrategyApplyObjects

Performs batch operations on application objects associated with a specified policy.

Go debug

Creating an Upgrade Policy

hcloud Workspace CreateTenantUpgradeStrategy

Creates an upgrade policy and associates it with an application object.

Go debug

Deleting Upgrade Policies in Batches

hcloud Workspace DeleteTenantUpgradeStrategy

Deletes upgrade policies in batches.

Go debug

Modifying an Upgrade Policy

hcloud Workspace UpdateTenantUpgradeStrategy

Modifies an upgrade policy and updates the associated application object information.

Go debug

Listing Upgrade Tasks

hcloud Workspace ListUpgradeTasks

Lists upgrade tasks by page.

Go debug

Listing Application Objects of an Upgrade Task

hcloud Workspace ListTaskApplyObjects

Lists application objects of a specified task by page.

Go debug

Creating a Scheduled Upgrade Task

hcloud Workspace CreateUpgradeScheduleTask

Creates an upgrade task and configures the scheduled task, execution policy, grayscale policy, and application objects.

Go debug

Deleting Upgrade Tasks in Batches

hcloud Workspace DeleteUpgradeTask

Deletes specified upgrade tasks in batches.

Go debug

Querying Details About an Upgrade Task

hcloud Workspace ShowUpgradeTaskDetail

Queries details about an upgrade task by task ID.

Go debug

Modifying an Upgrade Task

hcloud Workspace UpdateUpgradeTask

Modifies the configuration of an upgrade task.

Go debug

Triggering an Upgrade Task

hcloud Workspace ExecuteTriggerUpgrade

Triggers a desktop upgrade task based on the configured parameters.

Go debug

Querying Details About a Version

hcloud Workspace ShowTenantVersionConfig

Queries details about a version.

Go debug

Listing Versions

hcloud Workspace ListTenantVersionConfig

Lists versions. You can query versions by version type, version number, operating system type, release time, version status, and version description. Fuzzy search of version description will search for the version description configured by SRE and the version description customized by the tenant.

Go debug

Querying Projects, User Groups, and Users with AI Assistant Subscriptions

hcloud Workspace ListSubscribeAiAssistantUsers

Queries the projects, user groups, and users with AI Assistant Subscriptions.

Go debug

Subscribing to and Unsubscribing from the AI Assistant

hcloud Workspace SubscribeAiAssistant

Subscribers can use AI-powered capabilities.

Go debug

Querying User Usage Frequency Statistics

hcloud Workspace ShowAiAssistantUsageFrequency

Queries the user usage frequency statistics.

Go debug

Querying Alarms

hcloud Workspace ListAlarms

Queries alarms from Cloud Eye.

Go debug

Querying Alarm Statistics

hcloud Workspace ListAlarmStatistics

Number of alarms at each severity.

Go debug

Listing Common Skills (Read-Only)

hcloud Workspace ListCommonSkills

An enterprise tenant lists common skills (read-only). Filtering by category or status is supported.

Go debug

Querying Details About a Common Skill (Read-Only)

hcloud Workspace ShowCommonSkill

An enterprise tenant queries details about a common skill (read-only).

Go debug

Generating an Upload URL

hcloud Workspace CreateUploadUrls

This API is used to generate an OBS pre-signed URL for uploading an enterprise-developed skill package.

Go debug

Querying Skill Packages in Batches

hcloud Workspace BatchListSkillPackages

This API is used to query the information about skill packages that are currently in effect in batches based on the skill ID list.

Go debug

Listing Skill Packages

hcloud Workspace ListSkillPackages

This API is used to list skill packages of an enterprise-developed skill.

Go debug

Creating a Skill Package

hcloud Workspace CreateSkillPackage

This API is used to upload a new version skill package for an enterprise-developed skill.

Go debug

Querying Details About a Skill Package

hcloud Workspace ShowSkillPackage

This API is used to query details about an enterprise self-developed skill package.

Go debug

Updating a Skill Package

hcloud Workspace UpdateSkillPackage

This API is used to update the information about a skill package of an enterprise-developed skill.

Go debug

Deleting a Skill Package

hcloud Workspace DeleteSkillPackage

This API is used to delete the skill package of an enterprise-developed skill.

Go debug

Generating a Download URL

hcloud Workspace CreateDownloadUrl

This API is used to generate an OBS pre-signed download URL for the skill package of an enterprise-developed skill.

Go debug

Adding a Skill Package Region

hcloud Workspace ExpandSkillPackageRegion

This API is used to add a new OBS region for an enterprise-developed skill package.

Go debug

Removing Regions from a Skill Package

hcloud Workspace RemoveSkillPackageRegion

This API is used to remove OBS regions from an enterprise-developed skill package in batches.

Go debug

Listing Common Skill Packages (Read-Only)

hcloud Workspace ListCommonSkillPackages

An enterprise tenant lists skill packages of a common skill (read-only).

Go debug

Querying Details About a Common Skill Package (Read-Only)

hcloud Workspace ShowCommonSkillPackage

An enterprise tenant queries details about a common skill package (read-only).

Go debug

Binding Skills

hcloud Workspace CreateSkillBindings

This API is used to bind skills to instances in batches.

Go debug

Unbinding Skills

hcloud Workspace DeleteSkillBindings

This API is used to unbind skills in batches.

Go debug

Updating Security Policy Control

hcloud Workspace UpdateSecurityPolicyControl

This API is used to update the security policy control status of instances in batches.

Go debug

Listing Resources Controlled by a Security Policy

hcloud Workspace ListSecurityPolicyControlResources

This API is used to list resources under security policy control.

Go debug

Listing Resources Bound to a Common Skill

hcloud Workspace ListCommonSkillResources

This API is used to list resources bound to a common skill.

Go debug

Listing Resources Bound to an Enterprise-developed Skill

hcloud Workspace ListSkillResources

This API is used to list resources bound to an enterprise-developed skill.

Go debug

Listing Skills Bound to an Instance

hcloud Workspace ListInstanceSkills

This API is used to list the skills bound to an instance.

Go debug