All Products
Search
Document Center

Elastic Desktop Service:List of operations by function

Last Updated:Dec 22, 2025
This product(ecd/2020-09-30) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Regions

APITitleDescription
DescribeRegionsDescribeRegionsQueries the Alibaba Cloud regions that are available for Elastic Desktop Service (EDS).
DescribeZonesDescribeZonesQueries the zones in a region in which Elastic Desktop Service is supported.

Pricing

APITitleDescription
DescribePriceDescribePriceQueries the prices of Elastic Desktop Service (EDS) resources.
DescribeRenewalPriceDescribeRenewalPriceQueries the renewal price of an Alibaba Cloud Workspace service.
DescribeModificationPriceDescribeModificationPriceQueries the price for changing the specifications of a monthly subscription cloud computer with unlimited hours or a premium bandwidth plan.
DescribeRefundPriceDescribeRefundPriceQueries the refund amount for unsubscribing from a cloud computer.

Office networks (formerly workspaces)

APITitleDescription
GeneralGeneral
ListOfficeSiteOverviewListOfficeSiteOverviewQueries information about an office network, including its status, cloud computer quantity, virtual private cloud (VPC) type, and more.
DescribeOfficeSitesDescribeOfficeSitesQueries office network properties, including office network ID, name, status, and creation time.
ModifyOfficeSiteAttributeModifyOfficeSiteAttributeModifies the basic properties of an office network, including the name and local administrator permission settings.
ModifyOfficeSiteCrossDesktopAccessModifyOfficeSiteCrossDesktopAccessEnables 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.
DeleteOfficeSitesDeleteOfficeSitesDeletes office networks (formerly workspaces).
ModifyOfficeSiteDnsInfoModifyOfficeSiteDnsInfoModifies the DNS information of an office network.
Convenience office networks Convenience office networks
CreateSimpleOfficeSiteCreateSimpleOfficeSiteCreates an office network of the convenience account type. Elastic Desktop Service supports the following types of accounts: convenience accounts and enterprise AD accounts.
ActivateOfficeSiteActivateOfficeSiteUnlocks a convenience office network that is automatically locked due to a long idle period of time.
Enterprise AD office networksEnterprise AD office networks
CreateADConnectorOfficeSiteCreateADConnectorOfficeSiteCreates an enterprise Active Directory (AD) office network (formerly workspace). Elastic Desktop Service supports the following types of accounts: convenience accounts and enterprise AD accounts.
ListUserAdOrganizationUnitsListUserAdOrganizationUnitsObtains the organizational units (OUs) of an Active Directory (AD) domain that is connected to an enterprise AD office network (formerly workspace).
ListOfficeSiteUsersListOfficeSiteUsersQueries information about Active Directory (AD) accounts after an enterprise AD office network (formerly workspace) interconnects to an AD domain.
ModifyADConnectorOfficeSiteModifyADConnectorOfficeSiteModifies the basic properties of an enterprise Active Directory (AD) office network, such as the office network name and domain names of the enterprise AD subdomains.
ModifyOfficeSiteMfaEnabledModifyOfficeSiteMfaEnabledEnables or disables multi-factor authentication (MFA) for an enterprise Active Directory (AD) office network (formerly workspace).
ConfigADConnectorTrustConfigADConnectorTrustConfigures a conditional forwarder and trust relationship for a high-definition experience (HDX)-based office network (formerly workspace). You can call the operation to configure a trust relationship for an enterprise Active Directory (AD) office network.
ConfigADConnectorUserConfigADConnectorUser

Directories

APITitleDescription
CreateADConnectorDirectoryCreateADConnectorDirectoryCreates a directory of the Active Directory (AD) type.
CreateRAMDirectoryCreateRAMDirectoryCreates a Resource Access Management (RAM) directory.
DescribeDirectoriesDescribeDirectoriesQueries the details of directories.
ListDirectoryUsersListDirectoryUsersObtains the user information in the AD system if you use an AD directory to connect to an AD system.
ModifyADConnectorDirectoryModifyADConnectorDirectoryModifies an Active Directory (AD) directory.
DeleteDirectoriesDeleteDirectoriesDeletes one or more directories.

Cloud computers (formerly cloud desktops)

APITitleDescription
ResourcesResources
CreateDesktopsCreateDesktopsCreates cloud computers. If you specify end users when you create cloud computers, the cloud computers are assigned to the end users after the cloud computers are created.
CreateDiskEncryptionServiceCreateDiskEncryptionServiceEnables the disk encryption feature and adds the service-linked role that is encrypted by Cloud Drive Service to a Resource Access Management (RAM) user.
DescribeKmsKeysDescribeKmsKeysQueries 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.
DescribeDesktopInfoDescribeDesktopInfoQueries the basic information about cloud computers.
DescribeDesktopsDescribeDesktopsQueries the details of cloud computers.
DescribeDesktopTypesDescribeDesktopTypesQueries the instance types of cloud computers.
DescribeCustomizedListHeadersDescribeCustomizedListHeadersQueries the header information of the desktop list.
ExportDesktopListInfoExportDesktopListInfoExports a cloud computer list as a CSV file.
StartDesktopsStartDesktopsStarts stopped cloud computers. After the API operation is successfully called, the cloud computers enter the Running state.
StopDesktopsStopDesktopsStop cloud computers that are in the Running state. After the operation is successfully called, the cloud computers enter the Stopped state.
RebootDesktopsRebootDesktopsRestart cloud computers.
RebuildDesktopsRebuildDesktopsRebuilds images for one or more cloud computers.
SetDesktopMaintenanceSetDesktopMaintenanceSet the cloud computer maintenance mode.
ModifyDesktopNameModifyDesktopNameChanges the name of a cloud computer to a new name.
ModifyDiskSpecModifyDiskSpecChanges the performance level (PL) of a system disk or data disk.
ModifyDesktopChargeTypeModifyDesktopChargeTypeChanges the billing method of cloud computers to subscription or pay-as-you-go.
ModifyDesktopSpecModifyDesktopSpecChanges the instance type of a cloud computer and scales up the disks of the cloud computer.
ModifyDesktopTimerModifyDesktopTimerCreates or modifies scheduled tasks on cloud computers, such as starting, stopping, restarting, and resetting cloud computers on schedule.
ModifyDesktopHostNameModifyDesktopHostNameModifies the hostname of a Windows cloud computer in the Active Directory (AD) office network.
ModifyCustomizedListHeadersModifyCustomizedListHeadersModifies the layouts of cloud computer list headers, such as the required fields and the display and hide settings.
MigrateDesktopsMigrateDesktopsMigrates cloud computers from the current office network (formerly called workspace) to the new office network.
RenewDesktopsRenewDesktopsRenews monthly subscription cloud computers.
DeleteDesktopsDeleteDesktopsReleases pay-as-you-go cloud computers or expired subscription cloud computers.
Authorized usersAuthorized users
DescribeUsersPasswordDescribeUsersPasswordQueries the passwords of authorized users of a cloud computer.
GetConnectionTicketGetConnectionTicketObtains the credential that is used to connect to a cloud desktop.
DescribeGuestApplicationsDescribeGuestApplicationsQueries the applications and their processes of an end user.
ModifyUserEntitlementModifyUserEntitlementGrants permissions on cloud desktops to end users, or revokes the permissions from the end users.
ModifyEntitlementModifyEntitlementAssigns a cloud computer to end users and removes all original end users of the cloud computer.

Cloud computer pools (formerly desktop groups)

APITitleDescription
ResourcesResources
CreateDesktopGroupCreateDesktopGroupCreates a shared group.
GetDesktopGroupDetailGetDesktopGroupDetailQueries the information about a cloud computer share.
DescribeDesktopGroupsDescribeDesktopGroupsQueries cloud computer shares.
ExportDesktopGroupInfoExportDesktopGroupInfoExports cloud computer shares and saves the list as an XLSX file. Each entry includes the ID and name of the cloud computer share, the ID and name of the office network, the cloud computer share template, and the name of the security policy.
DescribeDesktopsInGroupDescribeDesktopsInGroupQueries the cloud computers in a share by billing method.
DisableDesktopsInGroupDisableDesktopsInGroupDisables specific cloud computers in a cloud computer share. After you call this operation to disable specific cloud computers, they enter the unavailable state.
ModifyDesktopGroupModifyDesktopGroupModifies a cloud computer share.
ResetDesktopsResetDesktopsResets cloud computers of a cloud computer share.
SetDesktopGroupScaleTimerSetDesktopGroupScaleTimerConfigures an auto scaling policy for a multi-session cloud computer. Elastic Desktop Service allows multiple end users to share a cloud computer in a multi-session cloud computer pool. This helps save costs.
SetDesktopGroupTimerSetDesktopGroupTimerConfigures a scheduled start, stop, restart, or reset task for a cloud computer share.
SetDesktopGroupTimerStatusSetDesktopGroupTimerStatusSets the status of a scheduled task for a cloud computer share, such as enabling or disabling it.
RenewDesktopGroupRenewDesktopGroupRenews a shared cloud computer.
DeleteDesktopGroupDeleteDesktopGroupReleases a cloud computer share.
Authorized usersAuthorized users
AddUserToDesktopGroupAddUserToDesktopGroupAdds authorized users for a cloud computer share. The system automatically assigns cloud computers from a share to authorized users based on administrator-configured rules.
DescribeUsersInGroupDescribeUsersInGroupQueries the information about authorized users of a cloud computer share, including the usernames, email addresses, mobile numbers, and cloud computer IDs.
DescribeUserConnectionRecordsDescribeUserConnectionRecordsQueries the connection records of an authorized user to cloud computers in a cloud computer pool.
ModifyUserToDesktopGroupModifyUserToDesktopGroupReplaces the existing authorized users of a cloud computer share with different users
RemoveUserFromDesktopGroupRemoveUserFromDesktopGroupRevokes user access permissions for a cloud computer share. Once access permissions for a cloud computer share are revoked from a user, the user can no longer access any cloud computers within that share.

Networks

APITitleDescription
CreateNetworkPackageCreateNetworkPackageCreates a premium bandwidth plan for an office network.
DescribeNetworkPackagesDescribeNetworkPackagesQueries the details of one or more premium bandwidth plans.
DescribeFlowMetricDescribeFlowMetricQueries the monitoring data of the desktop inbound bandwidth and the desktop outbound bandwidth, or the monitoring data of the workspace bandwidth originated from or destined for the Internet.
DescribeFlowStatisticDescribeFlowStatisticQueries cloud computer-level traffic statistics of a single office network.
DescribeAclEntriesDescribeAclEntriesQueries the details of an access control list (ACL) of an office network or a cloud computer.
ModifyAclEntriesModifyAclEntriesModify the Internet access control policy on the office network or cloud computer granularity.
AssociateNetworkPackageAssociateNetworkPackageBinds a premium bandwidth plan to an office network. A premium bandwidth plan is used together with only one office network.
DissociateNetworkPackageDissociateNetworkPackageUnbinds a premium bandwidth plan from an office network.
RenewNetworkPackagesRenewNetworkPackagesRenews premium bandwidth plans.
ModifyNetworkPackageBandwidthModifyNetworkPackageBandwidthModifies the bandwidth of a premium bandwidth plan.
ModifyNetworkPackageEnabledModifyNetworkPackageEnabledRestores or disables a premium bandwidth plan.
DeleteNetworkPackagesDeleteNetworkPackagesDeletes one or more premium bandwidth plans.

CEN instances

APITitleDescription
DescribeCensDescribeCensQueries the details of all Cloud Enterprise Network (CEN) instances within an Alibaba Cloud account.
VerifyCenVerifyCenVerifies the ID of a Cloud Enterprise Network (CEN) instance and the ID of the Alibaba Cloud account to which the instance belongs and checks whether a CIDR block conflict exists between the routes of the instance and the IPv4 CIDR blocks of the associated office network.
SendVerifyCodeSendVerifyCodeObtains the verification code that is required when you bind an advanced office network to a Cloud Enterprise Network (CEN) instance that belongs to another Alibaba Cloud account.
AttachCenAttachCenBinds an advanced office network to a Cloud Enterprise Network (CEN) instance.
DetachCenDetachCenUnbinds an advanced office network from a CEN instance.

Storage

APITitleDescription
CreateDriveCreateDriveCreates a user-level storage resource.
DeleteDriveDeleteDriveDeletes a drive.
DescribeDrivesDescribeDrivesQueries user-level storage resources.
NAS file systemsNAS file systems
CreateAndBindNasFileSystemCreateAndBindNasFileSystemCreates a File Storage NAS (NAS) file system and mount the file system to the workspace in which a desktop group resides.
CreateNASFileSystemCreateNASFileSystemCreate a NAS file system.
DescribeNASFileSystemsDescribeNASFileSystemsQueries the information about File Storage NAS (NAS) file systems.
ModifyNASDefaultMountTargetModifyNASDefaultMountTargetModifies the mount target of a File Storage NAS (NAS) file system.
ResetNASDefaultMountTargetResetNASDefaultMountTargetResets the mount target of a File Storage NAS (NAS) file system.
DeleteNASFileSystemsDeleteNASFileSystemsDeletes NAS file systems.

Template (new version)

APITitleDescription
CreateTemplateCreateTemplateCreates a custom cloud computer template. A cloud computer template (or simply "template") simplifies the process of creating cloud computers by providing a predefined set of configurations. This eliminates the need to manually configure each setting, saving significant time and effort.
DescribeTemplatesDescribeTemplatesQueries the details of cloud computer templates.
ModifyTemplateModifyTemplateModifies a custom cloud computer template.
DeleteTemplatesDeleteTemplatesDeletes custom cloud computer templates.
ModifyTemplateBaseInfoModifyTemplateBaseInfoModifies the basic information of a custom cloud computer template, including the template name and template description.

Cloud computer templates

APITitleDescription
CreateBundleCreateBundleCreates a custom cloud computer template.
DescribeBundlesDescribeBundlesQueries the details of cloud computer templates.
ModifyBundleModifyBundleModifies a custom cloud computer template.
DeleteBundlesDeleteBundlesDeletes custom cloud computer templates.

Images

APITitleDescription
CreateImageCreateImageCreates a custom image based on a deployed cloud computer. Then, you can use the custom image to create cloud computers that have the same configurations. This prevents the repeated settings when you create cloud computers.
CopyImageCopyImageCopy an image to another region. If you want to share an image across regions, you can call this operation to copy the image to the destination region and then share the image.
UploadImageUploadImageUploads your custom Windows image.
DescribeImagesDescribeImagesQueries the information about images.
DescribeImageModifiedRecordsDescribeImageModifiedRecordsQueries the image modification records of cloud computers.
DescribeImagePermissionDescribeImagePermissionQueries the recipient Alibaba Cloud accounts with which an image is shared.
ModifyImageAttributeModifyImageAttributeModifies the attributes of an image, including the name and description of the image.
ModifyImagePermissionModifyImagePermissionShares an image with other Alibaba Cloud accounts, or unshares an image from the recipient Alibaba Cloud accounts.
MigrateImageProtocolMigrateImageProtocolUpdate the protocols of images to Adaptive Streaming Protocol (ASP).
DeleteImagesDeleteImagesDeletes one or more custom images.
CancelCopyImageCancelCopyImageCancels the operation of copying an image to another region.

Snapshots

APITitleDescription
Snapshot managementSnapshot management
CreateSnapshotCreateSnapshotCreate a snapshot for a disk of a cloud computer to back up or restore the data on the disk.
ResetSnapshotResetSnapshotRestores the data of a disk from a snapshot.
DescribeSnapshotsDescribeSnapshotsQueries the snapshots that are created based on a cloud computer and the details of the snapshots.
DeleteSnapshotDeleteSnapshotDeletes one or more snapshots.
Automatic snapshot policiesAutomatic snapshot policies
CreateAutoSnapshotPolicyCreateAutoSnapshotPolicyCreates an automatic snapshot policy. WUYING WorkSpace automatically creates snapshots based on the time specified by the cron expression in the automatic snapshot policy.
DescribeAutoSnapshotPolicyDescribeAutoSnapshotPolicyQueries the automatic snapshot policy.
ApplyAutoSnapshotPolicyApplyAutoSnapshotPolicyApply an automatic snapshot policy to cloud computers. After the automatic snapshot policy is applied to the cloud computers, Elastic Desktop Service automatically creates snapshots for the cloud computers based on the time specified in the automatic snapshot policy.
ModifyAutoSnapshotPolicyModifyAutoSnapshotPolicyModifies the parameters of an automatic snapshot policy, such as the policy name and snapshot retention period.
CancelAutoSnapshotPolicyCancelAutoSnapshotPolicyCancels an automatic snapshot policy for cloud computers.
DeleteAutoSnapshotPolicyDeleteAutoSnapshotPolicyDeletes an automatic snapshot policy.

Policies

APITitleDescription
Global policiesGlobal policies
DeleteCenterPolicyDeleteCenterPolicyDeletes a global policy.
ModifyResourceCenterPolicyModifyResourceCenterPolicyModifies a global policy that is associated with a cloud resource.
ModifyCenterPolicyModifyCenterPolicyModifies a center policy.
DescribeResourceByCenterPolicyIdDescribeResourceByCenterPolicyIdQueries cloud resources that are associated with a global policy.
DescribeCenterPolicyListDescribeCenterPolicyListQueries center policies.
CreateCenterPolicyCreateCenterPolicyCreates a center policy.
CloneCenterPolicyCloneCenterPolicyClones a policy based on an existing global policy.
CreatePolicyGroupCreatePolicyGroupCreates a cloud computer policy.
DeletePolicyGroupsDeletePolicyGroupsDeletes one or more custom cloud computer policies.
ModifyPolicyGroupModifyPolicyGroupModifies the cloud computer policy.
ModifyDesktopsPolicyGroupModifyDesktopsPolicyGroupChanges an existing cloud computer policy for cloud computers.
DescribePolicyGroupsDescribePolicyGroupsQueries the details of a cloud computer policy.
ClonePolicyGroupClonePolicyGroupClones an existing policy to quickly create a policy.

Policy groups

APITitleDescription
CreateConfigGroupCreateConfigGroupCreates a configuration group. A configuration group stores the setup details for scheduled tasks on cloud computers.
ModifyConfigGroupModifyConfigGroupModifies the basic information of a configuration group.
DeleteConfigGroupDeleteConfigGroupDeletes a configuration group.
BindConfigGroupBindConfigGroupBinds a configuration group to resources.
UnbindConfigGroupUnbindConfigGroupUnbinds a configuration group from resources.
DescribeConfigGroupDescribeConfigGroupQueries configuration groups.
ModifyTimerGroupModifyTimerGroupModifies a scheduled task configuration group.
DescribeTimerGroupDescribeTimerGroupQueries a scheduled task configuration group.

MFA

APITitleDescription
DeleteVirtualMFADeviceDeleteVirtualMFADeviceDelete virtual multi-factor authentication (MFA) devices.
DescribeVirtualMFADevicesDescribeVirtualMFADevicesQueries the virtual multi-factor authentication (MFA) devices that are associated with Active Directory (AD) accounts.
UnlockVirtualMFADeviceUnlockVirtualMFADeviceUnlocks a virtual multi-factor authentication (MFA) device that is in the LOCKED state.
LockVirtualMFADeviceLockVirtualMFADeviceLocks a multi-factor authentication (MFA) device that is in the NORMAL state.

OTA

APITitleDescription
DescribeFotaTasksDescribeFotaTasksQueries a list of update tasks.
DescribeFotaPendingDesktopsDescribeFotaPendingDesktopsQueries information about the cloud computers whose images can be and are pending to be updated to the specified version.
UpdateFotaTaskUpdateFotaTaskEnables or disables the auto-push feature for an image update task.
ApproveFotaUpdateApproveFotaUpdateAllows you to upgrade images.

SSO

APITitleDescription
SetOfficeSiteSsoStatusSetOfficeSiteSsoStatusEnables or disables single sign-on (SSO) for a workspace.
SetIdpMetadataSetIdpMetadataUploads the metadata of a Security Assertion Markup Language (SAML) 2.0-based identity provider (IdP).
SetDirectorySsoStatusSetDirectorySsoStatusConfigures the single sign-on (SSO) status of an Active Directory (AD) directory.
GetOfficeSiteSsoStatusGetOfficeSiteSsoStatusQueries whether single sign-on (SSO) is enabled for a workspace.
GetSpMetadataGetSpMetadataObtains the metadata of a Security Assertion Markup Language (SAML) 2.0-based service provider (SP).

Cloud Assistant

APITitleDescription
StopInvocationStopInvocationStops a Cloud Assistant command that is running on one or more cloud desktops.
DescribeInvocationsDescribeInvocations
RunCommandRunCommandRuns a PowerShell or batch (.bat) command on one or more Windows cloud computers.

Tags

APITitleDescription
ListTagResourcesListTagResourcesQueries the tags of cloud computers.
TagResourcesTagResourcesAdds tags to cloud computers. This allows you to filter and manage cloud computers by tag.
UntagResourcesUntagResourcesRemoves tags from cloud computers. After you remove a tag, if the tag is not added to a cloud computer, the tag is automatically deleted.

Audits

APITitleDescription
DescribeClientEventsDescribeClientEventsQueries the operation logs of end users. For example, the logs record the events that end users start and stop cloud desktops, and disconnect desktop sessions.
ExportClientEventsExportClientEventsExports events that occur on a cloud desktop from an Alibaba Cloud Workspace client.
DescribeRecordingsDescribeRecordingsQueries the details of screen recording files.

Monitoring and maintenance

APITitleDescription
DescribeDesktopSessionsDescribeDesktopSessionsQueries the detailed session information of a cloud computer.
DescribeDesktopGroupSessionsDescribeDesktopGroupSessionsQueries cloud computer shares.
DescribeSessionStatisticDescribeSessionStatisticQueries the session statistics of a region.
DisconnectDesktopSessionsDisconnectDesktopSessionsDisconnects from desktop sessions.
ApplyCoordinationForMonitoringApplyCoordinationForMonitoringApplies for coordination monitoring. This operation is mainly used in administrator assistance scenarios and education scenarios.
GetCoordinateTicketGetCoordinateTicketObtains the credentials of the stream collaboration
CancelCoordinationForMonitoringCancelCoordinationForMonitoringCancels monitoring on stream collaboration.
ApplyCoordinatePrivilegeApplyCoordinatePrivilegeApplies for the coordinate permissions.
RevokeCoordinatePrivilegeRevokeCoordinatePrivilegeRevokes the coordinate permissions.

Data transfer plans

APITitleDescription
CreateBandwidthResourcePackagesCreateBandwidthResourcePackagesCreates data transfer plans.

File Transfer

APITitleDescription
ListTransferFilesListTransferFilesQueries the file information of a file transmission task.
TransferTaskApprovalCallbackTransferTaskApprovalCallbackQueries the transmission and approval result for a submitted file.

Application

APITitleDescription
ListInstalledAppsListInstalledAppsQueries applications installed on a cloud computer.

Others

APITitleDescription
DescribeEcdReportTasksDescribeEcdReportTasksQueries data report export tasks.
CreateEcdReportTaskCreateEcdReportTaskCreates a data report export task.
DescribeGlobalDesktopRecordsDescribeGlobalDesktopRecordsQueries the basic information of all cloud computers and the corresponding usage duration records.

其他

APITitleDescription
BatchModifyEntitlementBatchModifyEntitlement