API overview-Elastic Desktop Service-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (ecd/2020-09-30) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Region

API	Title	Description
DescribeRegions	View available regions and zones	Queries the Alibaba Cloud regions supported by WUYING Workspace.
DescribeZones	Query zones supported in a specified region	Queries the zones supported by Alibaba Cloud Workspace in a specified Alibaba Cloud region.

Pricing inquiry

API	Title	Description
DescribePrice	Query purchase price	Queries the purchase price of Elastic Desktop Service products.
DescribeRenewalPrice	Query renewal price	Queries the renewal price of an Elastic Desktop Service product.
DescribeModificationPrice	Query upgrade/downgrade price	Queries the price for upgrading or downgrading a monthly subscription (unlimited duration) cloud computer or premium Internet bandwidth.
DescribeRefundPrice	Query unsubscription price of monthly cloud computers	Queries the unsubscription price of cloud computers purchased on a monthly basis.

Office network (formerly workspace)

API	Title	Description
General office network	General office network
ListOfficeSiteOverview	ListOfficeSiteOverview	Queries information about an office network, including its status, cloud computer quantity, virtual private cloud (VPC) type, and more.
DescribeOfficeSites	Query office network details	Queries all attributes of an office network, including the ID, name, status, and creation time.
ModifyOfficeSiteAttribute	Modify office network attributes	Modifies the basic attributes of an office network (formerly workspace), such as the office network name and whether to grant local administrator permissions to cloud computer users.
ModifyOfficeSiteCrossDesktopAccess	ModifyOfficeSiteCrossDesktopAccess	Enables or disables the communication between cloud computers in an office network (formerly workspace). If you enable the communication between cloud computers in an office network, the cloud computers can access each other.
DeleteOfficeSites	DeleteOfficeSites	Deletes office networks (formerly workspaces).
ModifyOfficeSiteDnsInfo	ModifyOfficeSiteDnsInfo	Modifies the DNS information of an office network.
CreateOfficeSiteAccelerator	Enable global accelerator	Enables Global Accelerator (GA) for an office network.
DeleteOfficeSiteAccelerator	DeleteOfficeSiteAccelerator	Deletes a Global Accelerator (GA) configuration.
ModifyOfficeSiteAccelerator	ModifyOfficeSiteAccelerator	Modifies the Global Accelerator (GA) configuration.
Office network based on convenience accounts	Office network based on convenience accounts
CreateSimpleOfficeSite	Create a convenience account-based office network	Elastic Desktop Service supports two account systems: convenience accounts and enterprise AD accounts. Creates an office network (formerly workspace) based on convenience accounts.
ActivateOfficeSite	Unlock an office network	Unlocks an office network based on a convenience account that has been automatically locked after being idle for a certain period.
Office network based on enterprise AD accounts	Office network based on enterprise AD accounts
CreateADConnectorOfficeSite	Create an aD-based office network	Creates an office network (formerly workspace) based on an enterprise Active Directory (AD) account system. Elastic Desktop Service supports convenient accounts and enterprise AD accounts.
ListUserAdOrganizationUnits	ListUserAdOrganizationUnits	Obtains the organizational units (OUs) of an Active Directory (AD) domain that is connected to an enterprise AD office network (formerly workspace).
ListOfficeSiteUsers	Query AD account information	Queries the AD account information obtained after an AD office network (formerly workspace) is connected to an AD domain.
ModifyADConnectorOfficeSite	Modify an AD office network	Modifies the basic properties of an AD office network (formerly workspace), such as the office network name and the domain name of the enterprise AD subdomain.
ModifyOfficeSiteMfaEnabled	ModifyOfficeSiteMfaEnabled	Enables or disables multi-factor authentication (MFA) for an enterprise Active Directory (AD) office network (formerly workspace).
ConfigADConnectorTrust	Configure a trust relationship for an AD office network	Configures a trust relationship for an AD office network. For office networks (formerly workspaces) that use the HDX protocol, you must configure conditional forwarders and trust relationships before the networks can function properly.
ConfigADConnectorUser	Configure the OU and administrator of an AD office network	Specifies the organizational unit (OU) and administrator for an AD office network (formerly workspace).

Cloud computer

API	Title	Description
Cloud computer resources	Cloud computer resources
CreateDesktops	Create one or more cloud desktops	Creates one or more cloud desktops. If user information is provided during creation, the cloud desktops are directly assigned.
CreateDiskEncryptionService	Enable disk encryption	Enables the disk encryption feature and adds the service-linked role (SLR) for enterprise cloud disk encryption under the RAM user.
DescribeKmsKeys	DescribeKmsKeys	Queries Key Management Service (KMS) keys of users. The first time you call this operation, you can try to create a service key for Elastic Desktop Service (EDS) and call the operation to return results.
DescribeDesktopInfo	Query basic information of cloud computers	Queries the basic information of cloud computers.
DescribeDesktops	Query cloud desktop details	Queries the details of one or more cloud desktops.
DescribeDesktopTypes	Query cloud computer specification details	Queries the details of cloud computer specifications.
DescribeCustomizedListHeaders	Obtain the Table Headers of the WUYING Workspace List	Obtain the table header information of the WUYING Workspace list page.
ExportDesktopListInfo	Export cloud desktop list	Exports the cloud desktop list as a CSV file.
StartDesktops	Start one or more stopped cloud computers	Starts one or more stopped cloud computers. After the operation is called successfully, the cloud computers enter the Running state.
HibernateDesktops	Hibernate one or more cloud computers	Hibernates cloud computers.
WakeupDesktops	Wake up one or more cloud computers	Wakes up cloud computers from hibernation.
StopDesktops	Stop one or more running cloud computers	Stops one or more running cloud computers. After the operation is called, the cloud computers enter the Stopped state.
RebootDesktops	Restart one or more cloud computers	Restarts one or more cloud computers.
RebuildDesktops	Change image for cloud computers	Changes the image for one or more cloud computers.
SetDesktopMaintenance	Set cloud computer maintenance mode	Sets the maintenance mode for cloud computers.
ModifyDesktopName	Rename a cloud computer	Renames a specified cloud computer to a new name.
ModifyDiskSpec	Modify disk performance level	Modifies the performance level of the system cloud disk or data cloud disk of a cloud desktop.
ModifyDesktopChargeType	Modify cloud desktop billing method	Converts the billing method of cloud desktops to subscription or pay-as-you-go.
ModifyDesktopSpec	Change cloud computer specifications	Changes the instance type of a cloud computer and expands the system cloud disk and data cloud disk of the cloud computer.
ModifyDesktopTimer	ModifyDesktopTimer	Creates or modifies scheduled tasks on cloud computers, such as starting, stopping, restarting, and resetting cloud computers on schedule.
ModifyDesktopHostName	Modify the hostname of a windows cloud desktop in an AD office network	Modifies the hostname of a Windows cloud desktop in an AD office network.
ModifyCustomizedListHeaders	ModifyCustomizedListHeaders	Modifies the layouts of cloud computer list headers, such as the required fields and the display and hide settings.
MigrateDesktops	Migrate cloud computers to another office network	Migrates cloud computers from the current office network to a new office network.
RenewDesktops	Renew monthly subscription cloud computers	Renews one or more monthly subscription cloud computers.
DeleteDesktops	Release cloud computers	Releases one or more pay-as-you-go cloud computers or expired subscription cloud computers.
DescribeDesktopMetadata	Query cloud desktop metadata	Queries the list and metadata of cloud desktops across all regions.
Authorized cloud computer users	Authorized cloud computer users
DescribeUsersPassword	Query password of an account in a cloud computer image	Queries the password of an account in a cloud computer image. For example, when querying the query cache of passwords in the Chrome browser on a cloud computer, the end user is required to enter this password to authenticate.
GetConnectionTicket	Retrieve connection credential	Retrieves the connection credential for a cloud computer.
DescribeGuestApplications	DescribeGuestApplications	Queries the applications and their processes of an end user.
ModifyUserEntitlement	Add or remove cloud computer authorization for convenience users	Adds or removes the authorization of one or more cloud computers for one or more users.
ModifyEntitlement	ModifyEntitlement	Assigns a cloud computer to end users and removes all original end users of the cloud computer.
BatchModifyEntitlement	Batch modify user authorizations for cloud desktops	Assigns users to multiple cloud desktops in batches.

Shared cloud computer

API	Title	Description
Shared cloud computer resources	Shared cloud computer resources
CreateDesktopGroup	Create a shared cloud computer	Creates a shared cloud computer.
GetDesktopGroupDetail	Retrieve shared cloud desktop details	Retrieves the details of a shared cloud desktop.
DescribeDesktopGroups	Query the list and details of shared cloud computers	Queries the list and details of shared cloud computers.
ExportDesktopGroupInfo	Export shared cloud computer list	Exports the list of shared cloud computers to an XLSX file. Each record includes the shared cloud computer ID and name, office network ID and name, shared cloud computer template, security policy name, and other details.
DescribeDesktopsInGroup	Query cloud desktops in a shared cloud desktop	Queries the list of cloud desktops in a shared cloud desktop by billing method.
DisableDesktopsInGroup	Disable cloud computers in a shared cloud computer group	Disables cloud computers in a shared cloud computer group. After a cloud computer is disabled, its status changes to unavailable.
ModifyDesktopGroup	Modify a shared cloud computer	Modifies a shared cloud computer.
ResetDesktops	Reset shared cloud computers	Resets cloud computers within a shared cloud computer.
SetDesktopGroupScaleTimer	Set an automatic scaling policy for multi-session cloud computers	Sets an automatic scaling policy for multi-session cloud computers. Multi-session cloud computers allow multiple users to connect to the same cloud computer simultaneously, which reduces costs.
SetDesktopGroupTimer	SetDesktopGroupTimer	Configures a scheduled start, stop, restart, or reset task for a cloud computer share.
SetDesktopGroupTimerStatus	Set the status of a scheduled task for a shared cloud computer	Sets the status of a scheduled task for a shared cloud computer, such as enabling or disabling the scheduled task.
RenewDesktopGroup	Renew a subscription shared cloud computer	Renews a subscription shared cloud computer.
DeleteDesktopGroup	Release a shared Cloud desktop	Releases a shared Cloud Desktop.
Shared cloud computer users	Shared cloud computer users
AddUserToDesktopGroup	Add authorized users to a shared cloud computer	Adds authorized users to a shared cloud computer. Cloud computers within the shared cloud computer are automatically assigned to authorized users based on rules set by the administrator.
DescribeUsersInGroup	Query authorized user details of a shared cloud computer	Queries the details of all authorized users of a shared cloud computer, including the username, email address, phone number, and authorized cloud computer ID.
DescribeUserConnectionRecords	Query user connection records of a cloud computer pool	Queries the connection records of authorized users to pooled cloud computers in a cloud computer pool.
ModifyUserToDesktopGroup	ModifyUserToDesktopGroup	Replaces the existing authorized users of a cloud computer share with different users
RemoveUserFromDesktopGroup	Remove authorized users from a shared cloud computer	Removes specified authorized users from a shared cloud computer. Removed users can no longer connect to cloud computers within the shared cloud computer.

Premium internet bandwidth

API	Title	Description
CreateNetworkPackage	Create a premium bandwidth plan for an office network	Creates a premium bandwidth plan for an office network.
DescribeNetworkPackages	Query details of premium internet bandwidth plans	Queries the details of one or more premium Internet bandwidth plans.
DescribeFlowMetric	Query inbound and outbound bandwidth	Queries the inbound and outbound bandwidth monitoring data of a cloud computer, or the public inbound and outbound bandwidth monitoring data of a premium public bandwidth instance.
DescribeAclEntries	DescribeAclEntries	Queries the details of an access control list (ACL) of an office network or a cloud computer.
ModifyAclEntries	Modify public network access control policy	Modifies the public network access control policy at the office network or cloud computer granularity.
AssociateNetworkPackage	Associate a premium internet bandwidth plan with an office network	Associates a premium Internet bandwidth plan with an office network. A premium Internet bandwidth plan has a one-to-one relationship with an office network.
DissociateNetworkPackage	Disassociate premium internet bandwidth from an office network	Disassociates a premium Internet bandwidth plan from the office network to which it was previously bound.
RenewNetworkPackages	Renew subscription premium internet bandwidth	Renews subscription premium Internet bandwidth.
ModifyNetworkPackageBandwidth	Modify the bandwidth of a premium internet bandwidth plan	Modifies the bandwidth of a premium Internet bandwidth plan.
ModifyNetworkPackageEnabled	ModifyNetworkPackageEnabled	Restores or disables a premium bandwidth plan.
DeleteNetworkPackages	Delete premium internet bandwidth plans	Deletes one or more premium Internet bandwidth plans.
CreateQosRule	Create a rate limiting rule	Creates a rate limiting rule.
DeleteQosRules	Delete qoS rules	Deletes QoS rules.
DescribeQosRules	Query qoS rules	Queries QoS rules.
ModifyQosEntries	Modify rate limiting rule resource binding relationship	Modifies the resource binding relationship of a rate limiting rule.
ModifyQosRule	ModifyQosRule	You can modify a rate limiting rule.

Cloud enterprise network

API	Title	Description
DescribeCens	Query CEN instance information	Queries information about all Cloud Enterprise Network (CEN) instances under the current account.
VerifyCen	Verify a CEN instance	Verifies whether the Cloud Enterprise Network (CEN) instance ID and the associated Alibaba Cloud account ID are correct, and whether CIDR block conflicts exist between the instance routes and the office network IPv4 CIDR block.
SendVerifyCode	Obtain a verification code for joining a CEN instance under another account	Retrieves a verification code required when adding a premium office network to a Cloud Enterprise Network (CEN) instance that belongs to a different Alibaba Cloud account.
AttachCen	Associate an advanced office network with a CEN instance	Associates an advanced office network with a Cloud Enterprise Network (CEN) instance.
DetachCen	DetachCen	Unbinds an advanced office network from a CEN instance.

Virtual bridge

API	Title	Description
CreateVirtualBridge	Create a virtual bridge	Creates a virtual bridge.
DeleteVirtualBridge	Delete a virtual bridge	Modifies the status of a virtual bridge.
ModifyVirtualBridgeStatus	Modify the status of a virtual bridge	Modifies the status of a virtual bridge.
ModifyOfficeSiteBridgeInfo	Update bridge deployment information	Updates the behavior management bridge information.
ListVirtualBridges	List virtual bridges	Queries virtual bridges.
DescribeOfficeSiteBridgeInfo	Query virtual bridge details	Queries virtual bridge information.
ModifyVirtualBridgeLevel	Upgrade or downgrade virtual bridge specifications	Upgrades or downgrades the specifications of a virtual bridge.
RenewVirtualBridge	Renew a virtual bridge	Renews a virtual bridge.

Storage

API	Title	Description
CreateDrive	Create a user-level storage resource	Creates a user-level storage resource.
DeleteDrive	Delete a user-level storage resource	Deletes a cloud drive.
DescribeDrives	Query user-level storage resources	Queries user-level storage resources.
Enterprise cloud disk (formerly wuying Cloud disk)	Enterprise cloud disk (formerly wuying Cloud disk)
Cloud disk	Cloud disk
CreateCloudDriveService	Create an enterprise NAS drive	Creates an enterprise network-attached storage (NAS) drive (formerly Wuying CloudDisk).
Team shared disk	Team shared disk
DescribeCloudDiskGroupDrives	Query cloud disk team spaces	Queries the list of cloud disk team spaces.
DescribeCloudDiskGroups	Query cloud disk teams	Queries the list of cloud disk teams.
CreateCloudDriveGroup	Add a team space	Grants organization authorization for a cloud disk.
DescribeCloudDriveGroups	Query team shared drives	Queries the list and basic information of all team shared drives in an enterprise cloud drive.
ModifyCloudDriveGroups	ModifyCloudDriveGroups	Modifies team spaces.
DeleteCloudDriveGroups	Delete a team shared drive	Deletes a team shared drive.
User personal disk	User personal disk
CreateCloudDriveUsers	Add user personal drive	Adds a personal drive for a user in an enterprise network drive.
DescribeCloudDriveUsers	List user personal drives	Queries the list and basic information of all personal drives in an enterprise drive.
ModifyCloudDriveUsers	Modify user personal disk properties	Modify basic properties of a user's personal disk, such as the status and storage capacity limit.
DeleteCloudDriveUsers	Delete User Personal Drive	Delete the personal drive of a user in WUYING Workspace.
Permissions	Permissions
DescribeCloudDrivePermissions	Query permission settings of an enterprise cloud drive	Queries the permission settings of an enterprise cloud drive.
ModifyCloudDrivePermission	Modify user permissions for file transfer between enterprise file storage and on-premises devices	The default policy for the enterprise file storage is that all users can upload files from on-premises devices to the enterprise file storage, but cannot download files from the enterprise file storage to on-premises devices. You can invoke this API to add users with exception permissions.
File management	File management
CreateCdsFile	Create a Folder or Create a File Upload Job	Create a folder or initiate a file upload task in the cloud disk.
CompleteCdsFile	Complete file upload	Completes the file upload action after a file upload task is created.
CopyCdsFile	Copy a file or folder	Creates a copy of a file or folder in a cloud drive.
ListCdsFiles	Query cloud drive files and retrieve file download uRLs	Queries the file list in a cloud drive and retrieves download URLs for files.
GetAsyncTask	Retrieve asynchronous task information	Retrieves the details of a folder copy asynchronous node based on the AsyncTaskId parameter returned by the CopyCdsFile operation.
ModifyCdsFile	Modify cloud disk file attributes	Modifies the attributes of a cloud disk file or folder, such as the file name.
MoveCdsFile	Move a cloud disk file	Moves a file or folder in a cloud disk to a new location.
DownloadCdsFile	Download an enterprise cloud disk file	Retrieves the download URL of a specified file.
DeleteCdsFile	Delete a cloud drive file	Deletes a file or folder from a cloud drive.
File sharing	File sharing
CreateCdsFileShareLink	Create a file share	Creates a file share.
DescribeCdsFileShareLinks	DescribeCdsFileShareLinks	Queries file sharing links of a cloud disk in Cloud Drive Service.
ModifyCdsFileShareLink	ModifyCdsFileShareLink	Modifies the link for file sharing.
CancelCdsFileShareLink	Cancel file sharing	Cancels file sharing.
Folder sharing	Folder sharing
AddFilePermission	Create cloud disk shared folder	Creates a shared folder in a cloud disk.
ListFilePermission	ListFilePermission	Queries the permissions on a shared file on a drive.
RemoveFilePermission	Unshare a cloud disk folder	Unshares a folder in a cloud disk.
Shared NAS storage	Shared NAS storage
CreateAndBindNasFileSystem	Create and bind a NAS file system	Creates a NAS file system and binds it to the office network of a shared cloud computer.
CreateNASFileSystem	Create a NAS file system	Creates a NAS file system.
DescribeNASFileSystems	Query NAS file system information	Queries NAS file system information.
ModifyNASDefaultMountTarget	Modify the mount target of a NAS file system	Modifies the mount target of a NAS file system.
ResetNASDefaultMountTarget	Reset the mount point of a NAS file system	Resets the mount point of a NAS file system.
DeleteNASFileSystems	DeleteNASFileSystems	Deletes NAS file systems.

Template (new version)

API	Title	Description
CreateTemplate	Create a custom cloud computer template	Creates a custom cloud computer template. A cloud computer template is a collection of cloud computer configurations that reduces the configuration steps and accelerates the creation of cloud computers.
DescribeTemplates	Query cloud computer template details	Queries the details of cloud computer templates.
ModifyTemplate	Modify all parameters of a custom cloud computer template	Modifies all parameters of a custom cloud computer template.
DeleteTemplates	Delete a custom cloud computer template	Deletes a custom cloud computer template.
ModifyTemplateBaseInfo	Modify basic information of a custom cloud computer template	Modifies the basic information of a custom cloud computer template, including the template name and template description.

Template (legacy)

API	Title	Description
CreateBundle	Create a custom cloud computer template	Creates a custom cloud computer template.
DescribeBundles	Query details of cloud computer templates	Queries the details of cloud computer templates.
ModifyBundle	Modify a custom cloud computer template	Modifies a custom cloud computer template.
DeleteBundles	DeleteBundles	Deletes custom cloud computer templates.

Image

API	Title	Description
CreateImage	Create a custom image	Creates a custom image from a deployed cloud computer to quickly create more cloud computers with the same configuration, avoiding repeated configuration each time.
CopyImage	Copy an image across regions	Copies an image to another region. To share an image across regions, you can call this operation to copy the image to the destination region before sharing it.
UploadImage	Upload a custom windows image	Uploads a custom Windows image.
DescribeImages	Query image details	Queries the details of images.
DescribeImageModifiedRecords	Query image change records	Queries the image change records of a cloud computer.
DescribeImagePermission	DescribeImagePermission	Queries the recipient Alibaba Cloud accounts with which an image is shared.
ModifyImageAttribute	ModifyImageAttribute	Modifies the attributes of an image, including the name and description of the image.
ModifyImagePermission	ModifyImagePermission	Shares an image with other Alibaba Cloud accounts, or unshares an image from the recipient Alibaba Cloud accounts.
MigrateImageProtocol	MigrateImageProtocol	Update the protocols of images to Adaptive Streaming Protocol (ASP).
DeleteImages	DeleteImages	Deletes one or more custom images.
CancelCopyImage	Cancel cross-region image copy	Cancels an ongoing image copy operation to another region.

Snapshot

API	Title	Description
Snapshot management	Snapshot management
CreateSnapshot	CreateSnapshot	Create a snapshot for a disk of a cloud computer to back up or restore the data on the disk.
ResetSnapshot	Recover disk data from the snapshot	Recovers disk data from a snapshot.
DescribeSnapshots	Query the snapshot list and details of a cloud desktop	Queries the list and details of snapshots for a cloud desktop.
DeleteSnapshot	DeleteSnapshot	Deletes one or more snapshots.
Automatic snapshot policy	Automatic snapshot policy
CreateAutoSnapshotPolicy	Create an automatic snapshot policy	Creates an automatic snapshot policy that enables cloud computers to perform automatic creation of snapshots based on the schedule specified by a Cron expression.
DescribeAutoSnapshotPolicy	Query automatic snapshot policies	Queries automatic snapshot policies.
ApplyAutoSnapshotPolicy	Associate an automatic snapshot policy with cloud computers	Attaches an automatic snapshot policy to cloud computers. After the policy is attached, cloud computers perform automatic creation of snapshots at the times specified in the automatic snapshot policy.
ModifyAutoSnapshotPolicy	Modify an automatic snapshot policy	Modifies the configuration items of an automatic snapshot policy, including the policy name and snapshot retention period.
CancelAutoSnapshotPolicy	Cancel an automatic snapshot policy	Cancels the automatic snapshot policy for a cloud desktop.
DeleteAutoSnapshotPolicy	Delete automatic snapshot policies	Deletes automatic snapshot policies.

Policy

API	Title	Description
Regionless policy	Regionless policy
DeleteCenterPolicy	Delete a non-region-specific policy	Deletes a non-region-specific policy.
ModifyResourceCenterPolicy	ModifyResourceCenterPolicy	Modifies a global policy that is associated with a cloud resource.
ModifyCenterPolicy	Modify a regionless policy	Modifies the configuration of a regionless policy.
DescribeResourceByCenterPolicyId	Query resources not associated with a region policy	Queries cloud resources that are not associated with a region policy.
DescribeCenterPolicyList	查詢無地域策略	查詢無地域策略的詳細資訊。
CreateCenterPolicy	Create a region-independent policy	Creates a region-independent cloud desktop policy.
CloneCenterPolicy	Clone a region-independent policy	Clones a policy based on an existing region-independent policy.
CreatePolicyGroup	Create a cloud computer policy	Creates a cloud computer policy.
DeletePolicyGroups	DeletePolicyGroups	Deletes one or more custom cloud computer policies.
ModifyPolicyGroup	Modify a cloud computer policy	Modifies a cloud computer policy.
ModifyDesktopsPolicyGroup	ModifyDesktopsPolicyGroup	Changes an existing cloud computer policy for cloud computers.
DescribePolicyGroups	Query cloud desktop policy details	Queries the details of cloud desktop policies.
ClonePolicyGroup	Clone a cloud computer policy	Clones a cloud computer policy to quickly create a custom cloud computer policy.

Configuration group

API	Title	Description
CreateConfigGroup	Create a configuration group	Creates a configuration group. The configuration group contains the configuration information of scheduled tasks for cloud desktops.
ModifyConfigGroup	Modify configuration group basic information	Modifies the basic information of a configuration group, including the name and description.
DeleteConfigGroup	Delete a configuration group	Deletes a configuration group.
BindConfigGroup	Associate a configuration group	Associates a configuration group with a cloud computer or resource group.
UnbindConfigGroup	Unbind configuration groups	Unbinds configuration groups from resources.
DescribeConfigGroup	Query configuration group list	Queries the list of configuration groups.
ModifyTimerGroup	Modify configuration group settings	Modifies the specific settings of a configuration group, such as the configuration of scheduled tasks.
DescribeTimerGroup	Query configuration group details	Queries the details of a specified configuration group.
DescribeGlobalTimerBatches	Query scheduled task execution batch list	Queries the batch information of scheduled task execution history and returns aggregated execution results.
DescribeGlobalTimerRecords	Query global scheduled task execution records	Queries the execution records of scheduled tasks for cloud computers across regions.

MFA

API	Title	Description
DeleteVirtualMFADevice	DeleteVirtualMFADevice	Removes a virtual multi-factor authentication (MFA) device that is associated with an Active Directory (AD) account.
DescribeVirtualMFADevices	Query virtual MFA devices bound to AD accounts	Queries the virtual MFA devices bound to AD accounts.
UnlockVirtualMFADevice	UnlockVirtualMFADevice	Unlocks a virtual multi-factor authentication (MFA) device that is in the LOCKED state.
LockVirtualMFADevice	Lock a virtual MFA device	Locks a virtual MFA device that is in Normal state.

Image OTA upgrade

API	Title	Description
DescribeFotaTasks	Retrieve image upgrade task list	Retrieves a list of image upgrade tasks.
DescribeFotaPendingDesktops	Retrieve information about cloud desktops pending image upgrades	Retrieves the information about cloud desktops that can be upgraded to the image of a specified version but have not been upgraded.
UpdateFotaTask	UpdateFotaTask	Enables or disables the auto-push feature for an image update task.
ApproveFotaUpdate	Allow image upgrade	Allows an image upgrade.

SSO settings

API	Title	Description
SetOfficeSiteSsoStatus	Set SSO status for an office network	Enables or disables single sign-on (SSO) for an office network.
SetIdpMetadata	Upload identity provider metadata	Uploads metadata for a SAML 2.0-based identity provider (IdP).
SetDirectorySsoStatus	Set SSO status for an AD office network	Enables or shuts down the single sign-on (SSO) feature for an AD-based office network.
GetOfficeSiteSsoStatus	GetOfficeSiteSsoStatus	Queries whether single sign-on (SSO) is enabled for an office network.
GetSpMetadata	GetSpMetadata	Obtains the metadata of a Security Assertion Markup Language (SAML) 2.0-based service provider (SP).

Cloud assistant

API	Title	Description
StopInvocation	StopInvocation	Stop a process that executes the Cloud Assistant script in one or more cloud computers.
DescribeInvocations	Query the execution list and status of Cloud assistant scripts	Queries the execution list and status of Cloud Assistant scripts.
RunCommand	Execute a script on cloud computers	Executes a PowerShell or Bat script on one or more cloud computers that run Windows.

Audit

API	Title	Description
DescribeClientEvents	Query operation logs of end users	Queries the operation logs of end users, including events such as cloud computer startup, shutdown, and session disconnection.
ExportClientEvents	ExportClientEvents	Exports events that occur on a cloud desktop from an Alibaba Cloud Workspace client.
DescribeRecordings	Query screen recording details	Queries the details of screen recording files.
DescribeRecordFile	Query screen recording files across all regions	Queries the list of screen recording files across all regions.
DescribeGlobalDesktopRecords	Query global desktops and related usage records	Queries the basic information of all recent cloud computers and their corresponding usage duration records.

Terminal management

API	Title	Description
AddDevices	Add trusted devices	Adds trusted devices.
DeleteDevices	DeleteDevices	Deletes trusted devices.
AttachEndUser	Add bound users to a WUYING hardware terminal	If you want a hardware terminal to be accessible only to specified end users, you need to enable the trusted device authentication feature and add bound users to the hardware terminal.
DetachEndUser	DetachEndUser	Unbinds a hardware client from a user.
DescribeDevices	DescribeDevices	Queries the list of trusted devices.

Monitoring and O&M

API	Title	Description
DescribeDesktopSessions	Query cloud computer session details	Queries the detailed session information of cloud computers.
DescribeDesktopGroupSessions	Query session monitoring details of shared cloud computers	Queries the session monitoring details of shared cloud computers.
DescribeSessionStatistic	Query session statistics	Queries session statistics information across all regions.
DisconnectDesktopSessions	Disconnect cloud computer sessions	Disconnects cloud computer sessions.
ApplyCoordinationForMonitoring	Send a remote assistance request to an end user	Sends a remote assistance request from an administrator to an end user. This operation is mainly used in administrator assistance scenarios and education scenarios.
GetCoordinateTicket	Retrieve coordination flow ticket	Retrieves the coordination flow ticket used for remote assistance or shared coordination.
CancelCoordinationForMonitoring	Cancel a remote assistance request initiated to an end user	Cancels a remote assistance request initiated to an end user.
ApplyCoordinatePrivilege	Request stream coordination operation permissions	Requests permissions for stream coordination operations.
RevokeCoordinatePrivilege	Cancel stream coordination operation permissions	Cancels the permissions for stream coordination operations.

Data transfer plan

API	Title	Description
CreateBandwidthResourcePackages	CreateBandwidthResourcePackages	Creates data transfer plans.

File transfer

API	Title	Description
ListTransferFileDownloadUrl	Get download uRLs of transfer files	Retrieves the download URLs of transfer files.
ListTransferFiles	ListTransferFiles	Queries the file information of a file transmission task.
TransferTaskApprovalCallback	Submit file transfer approval result	Submits the approval result for a file transfer task.

Application

API	Title	Description
ListInstalledApps	ListInstalledApps	Queries applications installed on a cloud computer.

Report

API	Title	Description
DescribeEcdReportTasks	Query wuying report task list	Queries the list of data report export tasks.
CreateEcdReportTask	Create a WUYING report task	Creates a data report export task.

Other

API	Title	Description
DescribeOnlineUserCount	Query online user count metrics	Queries metrics such as the number of online users and the number of users with assigned desktops.
QueryHistoryActiveUserCount	Query historical daily and monthly active user counts	Queries the historical daily active user count and monthly active user count for a specified date.
QueryHistoryAvgMetricList	Query historical average monitoring metrics	Queries the historical average monitoring metrics of desktop resources within a specified date range.
QueryHistoryMetricDistribution	Query historical metric distribution	Queries the historical distribution of a specific metric within a specified time range.
QueryHistoryUsageDurationRank	Query desktop historical usage duration ranking	Queries and sorts historical usage duration by user or desktop dimension.
DescribeConsoleMessages	Query WUYING workspace management messages	Queries WUYING Workspace management messages.
DescribePeripheralDrivers	List peripheral drivers	Queries the peripheral drivers visible to the current account. Supports filtering by ownership, brand, device type, driver ID, and keyword, and returns paginated results.
DescribePrinterEvents	Query print logs of end users	Queries printer event information.
DescribeVulDesktops	Retrieve cloud desktop information for a vulnerability	Retrieves cloud desktop information for a vulnerability.
DescribeVulnerability	Retrieve vulnerability information	Retrieves vulnerability information.
GetAggregatedDesktops	Retrieve aggregated statistics for cloud desktops	Queries desktop statistics by different dimensions.
QueryActiveUserStatistic	Query active user statistics	Queries the trend of active user statistics within a specified time range. Returns the number of deduplicated active users at each time slice based on the specified time aggregation granularity (Period) for plotting online user trend charts.
QueryAuthUserConnectDurationList	Query authorized user connection duration	Queries the connection duration statistics of authorized users based on specified conditions. Statistics can be collected by daily cumulative duration or by individual session details.
QueryEndUserHistoryUsage	Query the historical usage duration of end users	Queries the usage duration rankings and details of end users within a specified date range for a tenant. It aggregates offline statistical data, summarizes the connection duration by user, and populates basic information and usage duration details for each cloud desktop for the users on the current page.
QueryHistoryActiveUserStatistic	Query historical active user statistics	Queries the daily historical active user count for a tenant within a specified time range. Based on offline statistical data, this operation aggregates and deduplicates active users by date to calculate daily active users (DAU). Filtering by user group and workspace is supported.
SendConsoleMessage	Send elastic desktop service management message	Sends a created Elastic Desktop Service management message.

API	Title	Description
CreateADConnectorDirectory	Create an AD directory	Creates an AD directory.
CreateRAMDirectory	Create a rAM-type directory	Creates a RAM-type directory.
DescribeDirectories	Query directory details	Queries the details of a directory.
ListDirectoryUsers	Query user information of an AD directory	Retrieves user information from an enterprise Active Directory (AD) if you use an AD directory to connect to your enterprise AD.
ModifyADConnectorDirectory	ModifyADConnectorDirectory	Modifies an Active Directory (AD) directory.
DeleteDirectories	DeleteDirectories	Deletes one or more directories.

API	Title	Description
ListTagResources	Queries the list of tags that are added to cloud computers	Queries the list of tags that are added to cloud computers.
TagResources	Adds tags to cloud desktops	Adds tags to specified cloud desktops. This makes it easier to filter and manage cloud desktops by tag.
UntagResources	Remove tags from cloud desktops	Removes tags from cloud desktops. After a tag is removed, if the tag is not added to any cloud desktop, the tag is automatically deleted.