Updated on 2026-10-14 GMT+08:00

API Overview

Table 1 Workspace APIs

Type

Description

Tenant configuration

Obtains and modifies the backup configuration of Workspace access addresses, and queries, modifies, and updates tenant configurations.

Workspace

Queries, enables, and cancels Workspace.

Certificates

Queries, creates, deletes, enables, and disables CA certificates.

Desktops

Queries, creates, modifies, and deletes desktops.

Desktop pools

Queries, creates, modifies, and deletes desktop pools.

Desktop naming policies

Queries, creates, updates, and deletes desktop naming policies.

Desktop tags

Queries, creates, deletes, and adds desktop tags.

Collaborative desktops

Purchases collaborative desktops and deletes associated resources.

Users

Queries, creates, and deletes users.

User groups

Queries, creates, and deletes user groups.

OUs

Queries OUs and imports user information in OUs.

Disks

Adds and deletes disks and expands disk capacity.

Snapshots

Queries snapshots, creates, deletes, and restores snapshots in batches.

Connection records

Queries login information and the number of login users, and exports connection records.

Policy groups

Queries, creates, updates, and deletes access policies.

Terminal-desktop binding

Queries, adds, modifies, and configures terminal-desktop binding.

Workspace hosts

Queries and updates Workspace host information.

Orders

Creates desktop orders, places orders for batch change of yearly/monthly resources, and queries prices for switching images and disks, and changing specifications of yearly/monthly desktops or desktop pools.

Product packages

Queries the product package list.

Screen recording audit

Queries screen recording records and screen recording details, and deletes screen recordings in batches.

Scheduled tasks

Queries scheduled tasks of creation, modification, and deletion.

Export center

Queries and deletes exported tasks.

Statistics

Queries added, updated, and deleted notification rules, and statistics of users and desktops.

Alarms

Queries alarms and alarm statistics.

User operation logs

Queries and configures user events.

Scripts

Queries, adds, updates, and deletes scripts, and queries script tasks and script execution details.

Quotas

Queries tenant quotas.

Images

Queries the product image list.

AZs

Queries AZs.

Tasks

Queries tasks and subtasks.

Networks

Queries bound and unbound EIPs, Internet access of desktops, and ports, and creates and modifies Workspace bandwidth.

Agencies

Enables and queries agencies.

App center

Queries, adds, modifies, and deletes applications, and sets application permissions.

Application control

Creates, queries, modifies, and deletes application rules, and adds, enables, and disables control rules.

Tenant version configurations

Queries version details and the version list.

Upgrade policies

Queries and exports the policy list, queries and batch updates application objects, and creates, modifies, and batch deletes policies.

Upgrade tasks

Queries the task list and details, queries the application object list, and creates, modifies, batch deletes, and triggers tasks.

AI features

Subscribes to and queries the AI assistant.

Model providers

Queries the template list, remote model list, and configuration list and details, and adds, queries, updates, and deletes configurations.

Models

Adds or deletes models in batches, queries model details, and updates models.

Model configurations

Associates and removes model groups in batches.

Model groups

Adds, updates, and deletes model groups, queries the model group list and details, binds or unbinds model groups to or from providers in batches, and queries the associated application objects and provider list.

Skills

Creates, queries, updates, and deletes enterprise-developed skills, and manages skill details.

Common skills

Queries the common skill details and list.

Skill binding

Binds and unbinds skills, updates security policies, and queries the resource list.

Skill packages

Creates, queries, updates, and deletes skill packages, generates URLs, and manages regions.

Agent instances

Queries the agent instance list, statistics, and model groups associated with an instance.

IM channel configurations

Delivers and deletes IM channel configurations, and queries the list of IM channel configurations.

For details, see Workspace APIs.

Table 2 Workspace Application Streaming APIs

Type

Description

Product packages

Queries the list of Workspace Application Streaming packages and session packages.

AZs

Queries AZs.

Disks

Queries disks.

Server groups

Queries, creates, deletes, and modifies server group lists.

Servers

Queries, creates, deletes, modifies, starts, and restarts servers.

Application groups

Queries, creates, deletes, and modifies application groups.

Applications

Queries published applications and modifies application information.

Application authorization

Queries application group authorization and cancels authorization.

Usage records

Queries application usage records and user session logout.

Policies

Queries, creates, deletes, and modifies policies.

Storage

Queries, creates, and deletes Workspace storage.

Tasks

Queries task execution statuses.

Quotas

Queries quota verification.

Server group tags

Queries, adds, and deletes server group tags.

Application repositories

Queries, creates, modifies, and deletes applications in an application repository.

Images

Queries, creates, and modifies image instances.

Orders

Creates orders.

Scheduled tasks

Queries, creates, modifies, and deletes scheduled tasks.

Tenant configuration

Queries enterprise system configurations and tenant information.