API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (ecd/2020-09-30) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Regions
|
API |
Title |
Description |
| DescribeZones | DescribeZones | Queries the zones supported by Elastic Desktop Service (EDS) in a region. |
Pricing
|
API |
Title |
Description |
| DescribePrice | Query new purchase price | Query the new purchase price of Elastic Desktop Service (EDS) products. |
| DescribeRenewalPrice | DescribeRenewalPrice | Retrieves the renewal price for an Elastic Desktop Service product. |
| DescribeModificationPrice | Query Upgrade/Downgrade Price | Query the Upgrade/Downgrade price for monthly subscription cloud desktops with unlimited duration or Internet premium bandwidth. |
| DescribeRefundPrice | DescribeRefundPrice | Query the refund amount for monthly subscription WUYING Workspaces. |
Office networks (formerly workspaces)
|
API |
Title |
Description |
| General | General | |
| DescribeOfficeSites | DescribeOfficeSites | Gets all properties of an office network, including its ID, name, status, and creation time. |
| ModifyOfficeSiteAttribute | ModifyOfficeSiteAttribute | Modifies basic attributes of an office site (formerly a workspace), such as its name and whether to grant users local administrative permissions on their cloud computers. |
| ModifyOfficeSiteDnsInfo | ModifyOfficeSiteDnsInfo | Modifies the DNS information of an office network. |
| CreateOfficeSiteAccelerator | CreateOfficeSiteAccelerator | Enables the Global Accelerator (GA) service for an office network. |
| DeleteOfficeSiteAccelerator | DeleteOfficeSiteAccelerator | Deletes a Global Accelerator (GA) configuration. |
| ModifyOfficeSiteAccelerator | ModifyOfficeSiteAccelerator | Modifies the Global Accelerator (GA) configuration. |
| Convenience office networks | Convenience office networks | |
| CreateSimpleOfficeSite | CreateSimpleOfficeSite | Elastic Desktop Service (EDS) supports two types of accounts: convenience accounts and enterprise AD accounts. Use this API to create an office network (formerly a workspace) that uses convenience accounts. |
| Enterprise AD office networks | Enterprise AD office networks | |
| ListOfficeSiteUsers | ListOfficeSiteUsers | Queries information about Active Directory (AD) accounts in an AD office network (formerly known as a workspace) that is connected to an AD domain. |
| ConfigADConnectorUser | Configure the organizational unit (OU) and administrator for the AD office network | Specify an organizational unit (OU) and administrator for the Active Directory (AD) office network (formerly known as workspace). |
Directories
|
API |
Title |
Description |
| ListDirectoryUsers | ListDirectoryUsers | If you use an Active Directory (AD) directory to connect to your enterprise AD, call this operation to retrieve user information from your enterprise AD. |
Cloud computers (formerly cloud desktops)
|
API |
Title |
Description |
| Resources | Resources | |
| CreateDesktops | Create one or more cloud desktops | Creates one or more Elastic Desktop Service (EDS) desktops. If you provide user information, the desktops are automatically assigned to the specified users. |
| 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 | DescribeDesktopInfo | Describes basic information about cloud desktops. |
| DescribeDesktops | DescribeDesktops | Query the details of your cloud computers. |
| DescribeDesktopTypes | DescribeDesktopTypes | Retrieves cloud computer specifications. |
| DescribeCustomizedListHeaders | Obtain the Table Headers of the WUYING Workspace List | Obtain the table header information of the WUYING Workspace list page. |
| StartDesktops | StartDesktops | Starts stopped cloud computers. After the API operation is successfully called, the cloud computers enter the Running state. |
| StopDesktops | StopDesktops | Stops one or more running cloud desktops. After a successful call, the specified cloud desktops enter the Stopped state. |
| RebootDesktops | RebootDesktops | Reboots one or more desktops. |
| RebuildDesktops | RebuildDesktops | Replaces the image of one or more cloud computers. |
| SetDesktopMaintenance | SetDesktopMaintenance | Set the cloud computer maintenance mode. |
| ModifyDiskSpec | ModifyDiskSpec | Modify the performance level of a cloud desktop's system disk or data disk. |
| ModifyDesktopChargeType | ModifyDesktopChargeType | Changes the billing method of a cloud desktop to subscription or pay-as-you-go. |
| ModifyDesktopSpec | ModifyDesktopSpec | Modifies the desktop type and expands the disks of a cloud desktop. |
| RenewDesktops | RenewDesktops | Renews one or more subscription-based WUYING Workspace instances. |
| DeleteDesktops | DeleteDesktops | Releases one or more pay-as-you-go or expired subscription cloud computers. |
| DescribeDesktopMetadata | Query metadata of Cloud Desktops | Lists cloud computers and their metadata from all regions. |
| Authorized users | Authorized users | |
| BatchModifyEntitlement | BatchModifyEntitlement | Assigns multiple cloud computers to users in a batch. |
Cloud computer pools (formerly desktop groups)
|
API |
Title |
Description |
| Resources | Resources | |
| CreateDesktopGroup | CreateDesktopGroup | Creating a shared EDS. |
| GetDesktopGroupDetail | GetDesktopGroupDetail | Queries the details of a cloud computer share. |
| DescribeDesktopGroups | DescribeDesktopGroups | Returns a detailed list of shared cloud desktops. |
| DescribeDesktopsInGroup | DescribeDesktopsInGroup | Find cloud computers in a shared cloud computer by billing method. |
| ModifyDesktopGroup | ModifyDesktopGroup | Modifies a shared cloud computer group. |
| ResetDesktops | ResetDesktops | Resets cloud desktops in a shared cloud desktop group. |
| RenewDesktopGroup | RenewDesktopGroup | Renews the subscription for a cloud computer pool. |
| DeleteDesktopGroup | DeleteDesktopGroup | Release a shared cloud computer. |
| Authorized users | Authorized users | |
| AddUserToDesktopGroup | AddUserToDesktopGroup | Adds authorized users to a shared cloud desktop group, automatically assigning cloud desktops within the group to these users based on rules defined by an administrator. |
| DescribeUsersInGroup | DescribeUsersInGroup | This operation queries the details of all authorized users in a cloud desktop group, including their usernames, email addresses, phone numbers, and the IDs of their authorized cloud desktops. |
| RemoveUserFromDesktopGroup | RemoveUserFromDesktopGroup | Removes specified authorized users from a shared desktop group. After an authorized user is removed, that user can no longer connect to the cloud desktops in the group. |
Networks
|
API |
Title |
Description |
| CreateNetworkPackage | CreateNetworkPackage | Creates a network package for an office network. |
| DescribeFlowMetric | Query Inbound Bandwidth and Outbound Bandwidth | Query the inbound bandwidth and outbound bandwidth of a cloud computer, or the inbound bandwidth and outbound bandwidth for public network access of premium public bandwidth, along with their monitoring data. |
| RenewNetworkPackages | RenewNetworkPackages | Renews subscription-based premium public bandwidth. |
| ModifyNetworkPackageBandwidth | ModifyNetworkPackageBandwidth | Modifies the bandwidth of a premium bandwidth plan. |
| ModifyNetworkPackageEnabled | ModifyNetworkPackageEnabled | Restores or disables a premium bandwidth plan. |
| DeleteNetworkPackages | DeleteNetworkPackages | You can delete one or more public network premium bandwidth allocations. |
CEN instances
|
API |
Title |
Description |
| DescribeCens | DescribeCens | Queries the details of all Cloud Enterprise Network (CEN) instances within an Alibaba Cloud account. |
Storage
|
API |
Title |
Description |
| CreateDrive | CreateDrive | Creates a user-level storage resource. |
| DeleteDrive | DeleteDrive | Deletes a drive. |
| DescribeDrives | DescribeDrives | Queries user-level storage resources. |
| Enterprise Drive Service | Enterprise Drive Service | |
| Drives | Drives | |
| CreateCloudDriveService | CreateCloudDriveService | Create a PDS (formerly Wuying Cloud Disk) |
| Teams | Teams | |
| DescribeCloudDiskGroupDrives | Query cloud drive group spaces | Lists cloud disk group drives. |
| DescribeCloudDiskGroups | Query cloud drive groups | Lists cloud disk groups. |
| CreateCloudDriveGroup | Add team space | Disk organization authorization. |
| DescribeCloudDriveGroups | Query the list of team shared drives | Query the list and basic information of all team shared drives in the enterprise cloud drive. |
| Users | Users | |
| CreateCloudDriveUsers | CreateCloudDriveUsers | Creates personal cloud drives for users within your enterprise cloud drive. |
| DescribeCloudDriveUsers | Query the list of user personal drives | Retrieves a list of personal drives and their basic information for all users in an enterprise network 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 the permission settings details of the enterprise cloud drive | Query the permission settings details of the 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. |
| Files | Files | |
| CreateCdsFile | Create a Folder or Create a File Upload Job | Create a folder or initiate a file upload task in the cloud disk. |
| CompleteCdsFile | CompleteCdsFile | After you create an object upload task, call this operation to upload the object. |
| CopyCdsFile | Copy a file or folder | Create a copy of a file or folder in the cloud drive. |
| ListCdsFiles | ListCdsFiles | Queries the list of files in the network disk and obtain the download link of the file. |
| ModifyCdsFile | ModifyCdsFile | Modifies the attributes of a disk file or folder, such as the file name. |
| DownloadCdsFile | DownloadCdsFile | Obtains the download link of the target file. |
| DeleteCdsFile | DeleteCdsFile | Delete files or folders from the network disk. |
| File sharing | File sharing | |
| CreateCdsFileShareLink | Create a file share | Create a file share. |
| Folder sharing | Folder sharing | |
| AddFilePermission | AddFilePermission | Adds a shared folder to the network disk. |
| ListFilePermission | ListFilePermission | Queries the permissions on a shared file on a drive. |
| RemoveFilePermission | RemoveFilePermission | Unshare a folder on the network disk. |
| NAS file systems | NAS file systems | |
| CreateNASFileSystem | CreateNASFileSystem | Create a NAS file system. |
| DescribeNASFileSystems | DescribeNASFileSystems | Queries NAS file systems. |
| ModifyNASDefaultMountTarget | ModifyNASDefaultMountTarget | Modifies the mount target of a File Storage NAS (NAS) file system. |
| ResetNASDefaultMountTarget | ResetNASDefaultMountTarget | Resets the mount target of a File Storage NAS (NAS) file system. |
| DeleteNASFileSystems | DeleteNASFileSystems | Deletes NAS file systems. |
Template (new version)
|
API |
Title |
Description |
| CreateTemplate | CreateTemplate | Creates 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. |
| DescribeTemplates | DescribeTemplates | Query the details of Cloud Desktop templates. |
| ModifyTemplate | ModifyTemplate | Modifies all parameters of a custom WUYING Workspace template. |
| DeleteTemplates | DeleteTemplates | Deletes custom cloud computer templates. |
| ModifyTemplateBaseInfo | ModifyTemplateBaseInfo | Modifies the basic information of a custom cloud computer template, including the template name and template description. |
Cloud computer templates
|
API |
Title |
Description |
| DescribeBundles | DescribeBundles | Queries the details of cloud computer templates. |
Images
|
API |
Title |
Description |
| CreateImage | CreateImage | Create a custom image from an existing WUYING Workspace. Use this image to quickly deploy more workspaces with identical configurations. Avoid repeating configuration steps each time you create a new workspace. |
| DescribeImageModifiedRecords | DescribeImageModifiedRecords | Queries the image change records of a cloud computer. |
Snapshots
|
API |
Title |
Description |
| Snapshot management | Snapshot management | |
| ResetSnapshot | Recover disk data from the snapshot | Recovers disk data from a snapshot. |
| DescribeSnapshots | Query the list and details of snapshots for cloud desktops | Queries the snapshots and their details for a cloud desktop. |
| Automatic snapshot policies | Automatic snapshot policies | |
| CreateAutoSnapshotPolicy | CreateAutoSnapshotPolicy | Creates an automatic snapshot policy that schedules snapshots for WUYING Workspace based on a cron expression. |
| DescribeAutoSnapshotPolicy | DescribeAutoSnapshotPolicy | Queries the details of automatic snapshot policies. |
| ModifyAutoSnapshotPolicy | ModifyAutoSnapshotPolicy | Modifies the name and snapshot retention period of an automatic snapshot policy. |
Policies
|
API |
Title |
Description |
| Global policies | Global policies | |
| ModifyCenterPolicy | Modify a policy without Region specification | Modifies a configuration that does not have a region-specific policy. |
| DescribeCenterPolicyList | DescribeCenterPolicyList | Query details of policies that are not region-specific. |
| CreateCenterPolicy | Create a Region-Free Policy | You can create a region-independent cloud desktop policy. |
| CloneCenterPolicy | CloneCenterPolicy | Clones a policy based on an existing global policy. |
| CreatePolicyGroup | CreatePolicyGroup | Creates a cloud computer policy. |
| ModifyPolicyGroup | ModifyPolicyGroup | Modifies cloud computer policies. |
| DescribePolicyGroups | DescribePolicyGroups | Retrieves the details of a cloud computer policy. |
Policy groups
|
API |
Title |
Description |
| CreateConfigGroup | Create Configuration Group | Create a configuration group. A configuration group contains settings for scheduled tasks on cloud desktops. |
| ModifyConfigGroup | ModifyConfigGroup | Modifies the basic information of a configuration group. |
| DeleteConfigGroup | DeleteConfigGroup | Deletes a configuration group. |
| BindConfigGroup | BindConfigGroup | Binds a configuration group to resources. |
| UnbindConfigGroup | UnbindConfigGroup | Unbinds a configuration group from resources. |
| DescribeConfigGroup | Query the configuration group list | Query the configuration group list information. |
| ModifyTimerGroup | Modify Configuration Group Settings | Modify configuration group settings, such as those for scheduled tasks. |
| DescribeTimerGroup | Query configuration group details | Retrieves details for a specified configuration group. |
| DescribeGlobalTimerBatches | Query the list of scheduled task execution batches | Queries for batch information from the execution history of scheduled tasks and returns aggregated results. |
| DescribeGlobalTimerRecords | Query global scheduled task execution records | This operation queries the scheduled task execution records for EDS across all regions. |
MFA
|
API |
Title |
Description |
| DescribeVirtualMFADevices | DescribeVirtualMFADevices | Retrieves the virtual multi-factor authentication (MFA) device associated with an Active Directory (AD) account. |
Cloud Assistant
|
API |
Title |
Description |
| DescribeInvocations | Query the execution list and status of Cloud Assistant scripts | Used to query the execution list and status of Cloud Assistant scripts. |
| RunCommand | RunCommand | Runs a PowerShell or Bat script on one or more cloud computers that run Windows. |
Audits
|
API |
Title |
Description |
| DescribeClientEvents | DescribeClientEvents | Query end-user operation logs for events such as starting and stopping a WUYING Workspace, and disconnecting from sessions. |
| DescribeRecordFile | Query the list of screen recording files across all regions | Retrieve screen recording files from all regions. |
| DescribeGlobalDesktopRecords | Query global desktops and related usage records | Queries basic information and usage duration for all recent Cloud Desktops. |
Monitoring and O&M
|
API |
Title |
Description |
| DescribeDesktopSessions | Query cloud desktop session details | Queries the detailed session information for cloud computers. |
| DescribeDesktopGroupSessions | DescribeDesktopGroupSessions | Queries cloud computer shares. |
| DescribeSessionStatistic | DescribeSessionStatistic | Queries the session statistics of a region. |
File Transfer
|
API |
Title |
Description |
| ListTransferFileDownloadUrl | Obtain the download URL of the transfer file | Retrieves the download URLs for transferred files. |
| TransferTaskApprovalCallback | TransferTaskApprovalCallback | Queries the transmission and approval result for a submitted file. |
Application
|
API |
Title |
Description |
| ListInstalledApps | ListInstalledApps | Queries applications installed on a cloud computer. |
Others
|
API |
Title |
Description |
| DescribeEcdReportTasks | DescribeEcdReportTasks | Queries data report export tasks. |
| CreateEcdReportTask | CreateEcdReportTask | Creates a data report export task. |
| ActivateOfficeSite | ActivateOfficeSite | Unlocks a convenience office network that is automatically locked due to a long idle period of time. |
| AddDevices | AddDevices | Adds trusted devices. |
| ApplyAutoSnapshotPolicy | ApplyAutoSnapshotPolicy | Apply 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. |
| ApplyCoordinatePrivilege | ApplyCoordinatePrivilege | Applies for the coordinate permissions. |
| ApplyCoordinationForMonitoring | ApplyCoordinationForMonitoring | Applies for coordination monitoring. This operation is mainly used in administrator assistance scenarios and education scenarios. |
| ApproveFotaUpdate | ApproveFotaUpdate | Allows you to upgrade images. |
| AssociateNetworkPackage | AssociateNetworkPackage | Binds a premium bandwidth plan to an office network. A premium bandwidth plan is used together with only one office network. |
| AttachCen | AttachCen | Binds an advanced office network to a Cloud Enterprise Network (CEN) instance. |
| AttachEndUser | AttachEndUser | Binds a hardware client to a user. |
| CancelAutoSnapshotPolicy | CancelAutoSnapshotPolicy | Cancels an automatic snapshot policy for cloud computers. |
| CancelCdsFileShareLink | CancelCdsFileShareLink | Cancels a file sharing task. |
| CancelCoordinationForMonitoring | CancelCoordinationForMonitoring | Cancels a remote assistance request to the end user. |
| CancelCopyImage | CancelCopyImage | Cancels the operation of copying an image to another region. |
| ClonePolicyGroup | ClonePolicyGroup | Clones an existing policy to quickly create a policy. |
| ConfigADConnectorTrust | ConfigADConnectorTrust | Configures 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. |
| CopyImage | CopyImage | Copy 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. |
| CreateADConnectorDirectory | CreateADConnectorDirectory | Creates a directory of the Active Directory (AD) type. |
| CreateADConnectorOfficeSite | CreateADConnectorOfficeSite | WUYING Workspace supports two account types: convenience accounts and Enterprise AD accounts. This operation creates an office network (formerly known as a workspace) for Enterprise AD accounts. |
| CreateAndBindNasFileSystem | CreateAndBindNasFileSystem | Creates a NAS file system and associate it with the office network of the shared cloud computer. |
| CreateBandwidthResourcePackages | CreateBandwidthResourcePackages | Creates data transfer plans. |
| CreateBundle | CreateBundle | Creates a custom cloud computer template. |
| CreateDiskEncryptionService | CreateDiskEncryptionService | Enables disk encryption and creates the required service-linked role in your Resource Access Management (RAM) user account for the Enterprise Drive. |
| CreateRAMDirectory | CreateRAMDirectory | Creates a Resource Access Management (RAM) directory. |
| CreateSnapshot | CreateSnapshot | Create a snapshot for a disk of a cloud computer to back up or restore the data on the disk. |
| DeleteAutoSnapshotPolicy | DeleteAutoSnapshotPolicy | Deletes an automatic snapshot policy. |
| DeleteBundles | DeleteBundles | Deletes custom cloud computer templates. |
| DeleteCenterPolicy | DeleteCenterPolicy | Deletes a global policy. |
| DeleteCloudDriveGroups | DeleteCloudDriveGroups | Deletes team spaces. |
| DeleteDevices | DeleteDevices | Deletes trusted devices. |
| DeleteDirectories | DeleteDirectories | Deletes one or more directories. |
| DeleteImages | DeleteImages | Deletes one or more custom images. |
| DeleteOfficeSites | DeleteOfficeSites | Deletes office networks (formerly workspaces). |
| DeletePolicyGroups | DeletePolicyGroups | Deletes one or more custom cloud computer policies. |
| DeleteSnapshot | DeleteSnapshot | Deletes one or more snapshots. |
| DeleteVirtualMFADevice | DeleteVirtualMFADevice | Removes a virtual multi-factor authentication (MFA) device that is associated with an Active Directory (AD) account. |
| DescribeAclEntries | DescribeAclEntries | Queries the details of an access control list (ACL) of an office network or a cloud computer. |
| DescribeCdsFileShareLinks | DescribeCdsFileShareLinks | Queries file sharing links of a cloud disk in Cloud Drive Service. |
| DescribeDevices | DescribeDevices | Queries the list of trusted devices. |
| DescribeDirectories | DescribeDirectories | Queries the details of directories. |
| DescribeFotaPendingDesktops | DescribeFotaPendingDesktops | Queries information about the cloud computers whose images can be and are pending to be updated to the specified version. |
| DescribeFotaTasks | DescribeFotaTasks | Queries a list of update tasks. |
| DescribeGuestApplications | DescribeGuestApplications | Queries the applications and their processes of an end user. |
| DescribeImagePermission | DescribeImagePermission | Queries the recipient Alibaba Cloud accounts with which an image is shared. |
| DescribeImages | DescribeImages | Queries the information about images. |
| DescribeNetworkPackages | DescribeNetworkPackages | Queries the details of one or more premium bandwidth plans. |
| DescribeOnlineUserCount | DescribeOnlineUserCount | Queries metrics such as the online user count and the assigned user count. |
| DescribeRecordings | DescribeRecordings | Queries the details of screen recording files. |
| DescribeRegions | DescribeRegions | Queries the Alibaba Cloud regions that are available for Elastic Desktop Service (EDS). |
| DescribeResourceByCenterPolicyId | DescribeResourceByCenterPolicyId | Queries cloud resources that are associated with a global policy. |
| DescribeUserConnectionRecords | DescribeUserConnectionRecords | Queries the connection records of an authorized user to cloud computers in a cloud computer pool. |
| DescribeUsersPassword | DescribeUsersPassword | Queries the passwords for the accounts within a cloud computer image. For example, when the Chrome browser on the cloud computer queries the cached password, it requires the end user to enter the password for identity verification. |
| DetachCen | DetachCen | Unbinds an advanced office network from a CEN instance. |
| DetachEndUser | DetachEndUser | Unbinds a hardware client from a user. |
| DisableDesktopsInGroup | DisableDesktopsInGroup | Disables specific cloud computers in a cloud computer share. After you call this operation to disable specific cloud computers, they enter the unavailable state. |
| DisconnectDesktopSessions | DisconnectDesktopSessions | Disconnects cloud computer sessions. |
| DissociateNetworkPackage | DissociateNetworkPackage | Unbinds a premium bandwidth plan from an office network. |
| ExportClientEvents | ExportClientEvents | Exports events that occur on a cloud desktop from an Alibaba Cloud Workspace client. |
| ExportDesktopGroupInfo | ExportDesktopGroupInfo | Exports 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. |
| ExportDesktopListInfo | ExportDesktopListInfo | Exports a cloud computer list as a CSV file. |
| GetAsyncTask | GetAsyncTask | When you call the CopyCdsFile operation to copy a folder, the operation returns AsyncTaskId. Call this operation specifying the obtained AsyncTaskId, and you can query the information about the asynchronous task. |
| GetConnectionTicket | GetConnectionTicket | Obtains the credential that is used to connect to a cloud desktop. |
| GetCoordinateTicket | GetCoordinateTicket | Get the stream collaboration credentials for remote assistance or shared collaboration. |
| 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). |
| HibernateDesktops | HibernateDesktops | Hibernates cloud desktops. |
| ListOfficeSiteOverview | ListOfficeSiteOverview | Queries information about an office network, including its status, cloud computer quantity, virtual private cloud (VPC) type, and more. |
| ListTagResources | Queries the list of tags that are added to cloud computers | Queries the list of tags that are added to cloud computers. |
| ListTransferFiles | ListTransferFiles | Queries the file information of a file transmission task. |
| ListUserAdOrganizationUnits | ListUserAdOrganizationUnits | Obtains the organizational units (OUs) of an Active Directory (AD) domain that is connected to an enterprise AD office network (formerly workspace). |
| LockVirtualMFADevice | LockVirtualMFADevice | Locks a multi-factor authentication (MFA) device that is in the NORMAL state. |
| MigrateDesktops | MigrateDesktops | Migrates one or more cloud computers to a new office network. |
| MigrateImageProtocol | MigrateImageProtocol | Update the protocols of images to Adaptive Streaming Protocol (ASP). |
| ModifyADConnectorDirectory | ModifyADConnectorDirectory | Modifies an Active Directory (AD) directory. |
| ModifyADConnectorOfficeSite | ModifyADConnectorOfficeSite | Modifies 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. |
| ModifyAclEntries | ModifyAclEntries | Modify the Internet access control policy on the office network or cloud computer granularity. |
| ModifyBundle | ModifyBundle | Modifies a custom cloud computer template. |
| ModifyCdsFileShareLink | ModifyCdsFileShareLink | Modifies the link for file sharing. |
| ModifyCloudDriveGroups | ModifyCloudDriveGroups | Modifies team spaces. |
| ModifyCustomizedListHeaders | ModifyCustomizedListHeaders | Modifies the layouts of cloud computer list headers, such as the required fields and the display and hide settings. |
| ModifyDesktopHostName | ModifyDesktopHostName | Modifies the hostname of a Windows cloud desktop in an AD workspace. |
| ModifyDesktopName | ModifyDesktopName | Modifies the name of a specified cloud desktop. |
| ModifyDesktopTimer | ModifyDesktopTimer | Creates or modifies scheduled tasks on cloud computers, such as starting, stopping, restarting, and resetting cloud computers on schedule. |
| ModifyDesktopsPolicyGroup | ModifyDesktopsPolicyGroup | Changes an existing cloud computer policy for cloud computers. |
| ModifyEntitlement | ModifyEntitlement | Assigns a cloud computer to end users and removes all original end users of the cloud computer. |
| 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. |
| 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. |
| ModifyOfficeSiteMfaEnabled | ModifyOfficeSiteMfaEnabled | Enables or disables multi-factor authentication (MFA) for an enterprise Active Directory (AD) office network (formerly workspace). |
| ModifyResourceCenterPolicy | ModifyResourceCenterPolicy | Modifies a global policy that is associated with a cloud resource. |
| ModifyUserEntitlement | ModifyUserEntitlement | Grants permissions on cloud desktops to end users, or revokes the permissions from the end users. |
| ModifyUserToDesktopGroup | ModifyUserToDesktopGroup | Replaces the existing authorized users of a cloud computer share with different users |
| MoveCdsFile | MoveCdsFile | Move files or folders. |
| QueryHistoryActiveUserCount | QueryHistoryActiveUserCount | Queries the historical daily and monthly active user counts for a specified date. |
| QueryHistoryAvgMetricList | QueryHistoryAvgMetricList | Retrieves historical average monitoring metrics for a desktop resource over a specified date range. |
| QueryHistoryMetricDistribution | QueryHistoryMetricDistribution | Queries the historical distribution of a specific metric over a specified time period. |
| QueryHistoryUsageDurationRank | QueryHistoryUsageDurationRank | Queries and ranks historical usage duration by end user or desktop. |
| RevokeCoordinatePrivilege | RevokeCoordinatePrivilege | Revokes the coordinate permissions. |
| SendVerifyCode | SendVerifyCode | Obtains 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. |
| SetDesktopGroupScaleTimer | SetDesktopGroupScaleTimer | Configures 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. |
| SetDesktopGroupTimer | SetDesktopGroupTimer | Configures a scheduled start, stop, restart, or reset task for a cloud computer share. |
| SetDesktopGroupTimerStatus | SetDesktopGroupTimerStatus | Sets the status of a scheduled task for a cloud computer share, such as enabling or disabling it. |
| SetDirectorySsoStatus | SetDirectorySsoStatus | Enables or disables the single sign-on (SSO) feature for an Active Directory (AD) account-based office network. |
| SetIdpMetadata | SetIdpMetadata | Uploads the metadata of a Security Assertion Markup Language (SAML) 2.0-based identity provider (IdP). |
| SetOfficeSiteSsoStatus | SetOfficeSiteSsoStatus | Enables or disables single sign-on (SSO) for an office network. |
| StopInvocation | StopInvocation | Stop a process that executes the Cloud Assistant script in one or more 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. |
| UnlockVirtualMFADevice | UnlockVirtualMFADevice | Unlocks a virtual multi-factor authentication (MFA) device that is in the LOCKED state. |
| 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. |
| UpdateFotaTask | UpdateFotaTask | Enables or disables the auto-push feature for an image update task. |
| UploadImage | UploadImage | Uploads your custom Windows image. |
| VerifyCen | VerifyCen | Verifies 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. |
| WakeupDesktops | WakeupDesktops | Wakes up cloud computers. |
Other
|
API |
Title |
Description |
| CreateQosRule | CreateQosRule | Creates a QoS rule. |
| DeleteQosRules | DeleteQosRules | Delete a rate-limiting rule. |
| DescribeQosRules | DescribeQosRules | Queries QoS rules. |
| ModifyQosEntries | ModifyQosEntries | Modifies the resource bindings of a QoS rule. |
| ModifyQosRule | ModifyQosRule | You can modify a rate limiting rule. |