# Alibaba Cloud Cloud Desktop API

> Alibaba Cloud Cloud Desktop API on Apizie: 29 endpoints (Creates a cluster, Creates an image, Creates an instance, Creates a service-linked role for WUYING Workspace, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-gws/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-gws`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/gws
- Page: https://zieapi.vercel.app/api/cloud/aliyun-gws
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-gws/openapi.json

Alibaba Cloud OpenAPI for Cloud Desktop (gws, version 2019-06-18). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/create-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| VpcId | string | yes | The VPC ID |
| ClusterType | string | yes | The cluster type. Valid values: gws.s1.standard |
| VSwitchId | string | no | The vSwitch ID used to create cluster servers. If this parameter is not specified, the system automatically finds the latest active zone… |

### Creates an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/create-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Name | string | no | The image name |

### Creates an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| VSwitchId | string | no | The vSwitch ID. If specified, the instance is created in this vSwitch. Specify this parameter when you create an instance to define the… |
| Name | string | no | The instance name |
| ImageId | string | yes | The image ID |
| SystemDiskSize | integer | yes | The system cloud disk size. Unit: GB. Valid values: 20 to 500. When you select an image, the system cloud disk size must be greater than… |
| SystemDiskCategory | string | yes | The category of the system cloud disk. Valid values: cloud_efficiency: ultra cloud disk. cloud_ssd: standard SSD. cloud_essd: Enterprise… |
| AllocatePublicAddress | string | no | Specifies whether to assign a public IP address. Valid values: True False |
| InternetChargeType | string | no | This parameter takes effect only when AllocatePublicAddress is set to true. The billing method for network usage. Valid values:… |
| InternetMaxBandwidthIn | integer | no | This parameter takes effect only when AllocatePublicAddress is set to true. The maximum inbound public bandwidth. Unit: Mbit/s. Valid… |
| InternetMaxBandwidthOut | integer | no | This parameter takes effect only when AllocatePublicAddress is set to true. The maximum outbound public bandwidth. Unit: Mbit/s. Valid… |
| InstanceType | string | yes | The instance type. For more information, see Instance families (https://help.aliyun.com/document_detail/25378.html) or call… |
| InstanceChargeType | string | no | The billing method of the instance. Valid values: PostPaid (default): pay-as-you-go. PrePaid: subscription |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: False (default) True |
| Period | integer | no | This parameter takes effect only when InstanceChargeType is set to PrePaid (subscription). The subscription duration. If PeriodUnit is set… |
| PeriodUnit | string | no | This parameter takes effect only when InstanceChargeType is set to PrePaid (subscription). The unit of the subscription duration. Valid… |
| WorkMode | string | yes | The work mode. Valid values: Desktop: desktop mode. Application: application mode |
| AppList | string | no | The application list (JSON-encoded) |

### Creates a service-linked role for WUYING Workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/create-service-linked-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |

### Deletes a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/delete-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |

### Deletes an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/delete-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ImageId | string | yes | The ID of the image |

### Deletes an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries the specifications and zone list of Cloud Desktop clusters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/describe-available-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |

### Queries the information about the Active Directory (AD) associated with a Cloud Desktop cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/describe-cluster-addomain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| TaskId | string | no | The task ID obtained by calling SetClusterADDomain |

### Query session connection information for a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/describe-cluster-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cloud desktop cluster ID |
| StartTime | string | yes | The start date of the query interval |
| EndTime | string | yes | The end date of the query interval |
| TaskId | string | no | The task ID for asynchronous queries |

### Get cluster policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/describe-cluster-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| TaskId | string | no | This value is only valid when `AsyncMode` is `true` When not empty, used to obtain the execution status of a previously submitted query… |
| AsyncMode | string | no | Asynchronous mode invocation: false (default): The API returns only after the command execution is complete. true: The API returns… |
| ClusterId | string | yes | Cluster ID |

### Calls DescribeClusters to query cluster information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/describe-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ClusterId | string | no | The cluster ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of rows per page |

### Describes images
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/describe-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceType | string | no | Instance type |

### Retrieves the policy configuration status of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/describe-instance-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| TaskId | string | no | This value is valid only when `AsyncMode` is set to `true`. If this parameter is not empty, it is used to retrieve the execution status of… |
| AsyncMode | string | no | Specifies whether to use asynchronous mode: false (default): The API returns only after the command execution is complete. true: The API… |

### Describes instance information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/describe-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of instances per page |
| ClusterId | string | no | Lists all instances in the specified cluster ID. If this parameter is not specified, instances in all clusters are listed |
| InstanceId | string | no | Lists the information of the specified instance ID. If this parameter is not specified, all instances are listed |
| UserUid | integer | no | Lists all instances assigned to the specified user ID. If this parameter is not specified, instances of all users are listed |
| UserName | string | no | Lists all instances assigned to the specified user. If this parameter is not specified, instances of all users are listed |

### Retrieves the token required to connect to an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/get-connect-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AppName | string | no | Do not specify this parameter when `WorkMode` is set to `Desktop` (desktop mode). This parameter is required when `WorkMode` is set to… |
| UserName | string | no | This parameter is required when the DomainName field returned by DescribeInstances is not empty and the caller is an assigned user of the… |
| Password | string | no | This parameter is required when the DomainName field returned by DescribeInstances is not empty and the caller is an assigned user of the… |
| TaskId | string | no | This parameter takes effect only when `AsyncMode` is set to `true`. If this parameter is not empty, it is used to retrieve the execution… |
| AsyncMode | string | no | Specifies whether to use asynchronous mode. false (default): The API returns a response only after the command is executed. true: The API… |
| UsePrivateIp | string | no | Specifies whether to use an internal IP address to connect to the Cloud Desktop: false (default): When retrieving the connection token,… |

### Queries the permissions of the current user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/is-user-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |

### Restarts an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/restart-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Associates or dissociates a Cloud Desktop cluster with an Active Directory (AD) domain by calling…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/set-cluster-addomain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| DomainDnsIp | string | yes | The DNS IP address of the AD domain |
| DomainName | string | yes | The domain name of the AD domain |
| DomainPassword | string | yes | The administrator password of the AD domain |
| DomainAdmin | string | no | The administrator password of the AD domain |
| DomainDelete | string | no | Specifies whether to associate the cluster with the AD domain. Valid values: false: Associates the cluster with the AD domain. true:… |

### Associates a cluster with a NAT gateway. After the association, desktops are connected through DNAT and EIP
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/set-cluster-dnat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| NatId | string | yes | The NAT gateway ID. If this parameter is set to a non-empty value, the specified NAT gateway is associated with the cluster. The NAT… |
| NatEip | string | no | If NatId is set to a non-empty value: * If this parameter is set to a non-empty value, the specified EIP is used for the association with… |

### Sets the name of a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/set-cluster-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| Name | string | yes | The cluster name to set |

### Sets the policy for a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/set-cluster-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The cluster ID |
| UsbRedirect | string | yes | The USB redirection policy. Valid values: off: disabled. on: enabled |
| Watermark | string | yes | The watermark policy. Valid values: off: disabled. on: enabled. The watermark consists of two lines of semi-transparent text in a star… |
| LocalDrive | string | yes | The local drive mapping policy. Valid values: off: disabled. read: read-only. readwrite: read and write |
| Clipboard | string | yes | The clipboard policy. Valid values: off: disabled. read: read-only. write: write-only. readwrite: read and write |
| UdpPort | string | no | The UDP port policy. Valid values: on (default): enabled. We recommend that you set this parameter to on for better bandwidth usage and… |
| Audio | string | no | The audio policy. Valid values: on (default): enabled. The client can hear audio from the Cloud Desktop. off: disabled. The client cannot… |
| DomainList | string | no | The domain name whitelist. If the whitelist is empty, access to all domain names is allowed. If the whitelist is not empty, only domain… |
| AsyncMode | string | no | Specifies whether to use asynchronous mode. Valid values: false (default): The API returns a response only after the command is executed.… |

### Sets the name of an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/set-image-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| ImageId | string | yes | The image ID |
| Name | string | yes | The image name |

### Sets the name of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/set-instance-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Name | string | yes | The instance name |

### Sets the policy status of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/set-instance-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| VisualLossless | string | no | Valid only for GPU instances. Enable this option to obtain better image quality. The visual lossless mode. Valid values: off (default):… |
| OptimizeFor3d | string | no | Valid only for GPU instances. Enable this option to obtain lower desktop latency. GPU acceleration. Valid values: off (default): Disabled.… |
| AsyncMode | string | no | Specifies whether to use asynchronous mode. Valid values: false (default): The API returns only after the setting is complete. true: The… |

### Assigns a user to an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/set-instance-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| UserUid | integer | yes | The user ID |
| UserName | string | yes | The username |

### Starts an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/start-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Stops an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/stop-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://gws.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-gws/create-cluster" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Cloud Desktop API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-gws/create-cluster with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Cloud Desktop API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Cloud Desktop itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Cloud Desktop API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-gws.

### What is the status of the Alibaba Cloud Cloud Desktop API?
Needs your own provider key (bring your own key)