# Alibaba Cloud Alibaba Cloud Workspace Terminal API

> Alibaba Cloud Alibaba Cloud Workspace Terminal API on Apizie: 8 endpoints (Creates dedicated terminal management invitation codes for one or more users under the current Alibaba Cloud…, Removes managed terminal devices by UUID, Queries information about all managed clients, Retrieves custom resource statistics information, …) 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-wyota/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Alibaba Cloud Workspace Terminal (wyota, version 2021-04-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates dedicated terminal management invitation codes for one or more users under the current Alibaba Cloud…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-wyota/create-user-invitation-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| EndUserId | string | no | The logon identifier (EndUserId) of a single user, used for compatibility with single-user creation. You must specify either this… |
| EndUserIds | string | no | The array of user logon identifiers (EndUserIds). You must specify either this parameter or EndUserId. You can specify 1 to 100 unique,… |
| TerminalGroupId | string | yes | The ID of the terminal group. The group must belong to the current account and must not be deleted. After the corresponding terminal uses… |
| ValidityMinutes | integer | yes | The validity period of the management code, in minutes. A value of -1 indicates that the code is permanently valid. For values between 60… |

### Removes managed terminal devices by UUID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-wyota/delete-clients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InManage | string | yes | Specifies whether the device is managed |
| Uuids | string | yes | The UUIDs of the asset instances. Separate multiple UUIDs with commas (,) (JSON-encoded) |
| CallerAliUid | string | no | The Alibaba Cloud account ID |

### Queries information about all managed clients
`POST https://zieapi.vercel.app/v1/cloud:aliyun-wyota/describe-clients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TerminalGroupId | string | no | The group ID |
| Uuids | string | no | The UUIDs of the servers to query. Separate multiple UUIDs with commas (,) (JSON-encoded) |
| SearchKeyword | string | no | The fuzzy search parameter. Supports fuzzy search by SN, alias, or IP address. This parameter is incompatible with exact search parameters |
| NextToken | string | no | The token for the next page |
| InManage | string | no | Specifies whether the client is managed |
| MaxResults | integer | no | The maximum number of results to return |
| WithBindUser | string | no | Specifies whether to return bound users |
| Model | string | no | The device model |
| IncludeSubGroups | string | no | Specifies whether to include subgroups |
| ClientType | integer | yes | The client type |
| OnlineStatus | string | no | The soft client status |
| Platform | string | no | The soft client platform |
| CustomResourceId | string | no | The custom task ID |
| CustomResourceStatus | string | no | The effective status of the custom task. Valid values: true: effective. false: ineffective. null: all |
| CallerAliUid | string | no | The Alibaba Cloud account ID |

### Retrieves custom resource statistics information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-wyota/get-custom-resource-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| MainBizType | string | no | The business type. Default value: enterprise |

### Retrieves or creates an invitation code for desktop device enrollment. Query mode: Pass only terminalGroupId…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-wyota/get-or-create-invitation-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ExpireDays | integer | no | The validity period in days, calculated from the current time. Set to -1 for permanent validity |
| TerminalGroupId | string | no | The terminal group ID |
| Type | integer | no | The validity period type. Valid values: 1: The response returns the expiration in days. This is the default value if Type is not… |
| ExpireMinutes | integer | no | The validity period in minutes, calculated from the current time. Set to -1 for permanent validity |

### Retrieves the number of terminals
`POST https://zieapi.vercel.app/v1/cloud:aliyun-wyota/get-terminal-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ClientType | integer | no | The terminal type. Valid values: 1: hardware terminal. 2: software terminal. 3: secure browser plug-in. 4: GuestOS application. 5:… |

### Queries the version distribution of terminals
`POST https://zieapi.vercel.app/v1/cloud:aliyun-wyota/list-version-distribution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InManage | string | no | The management status. A value of true indicates managed, and a value of false indicates unmanaged. If this parameter is not specified,… |
| VersionType | string | yes | The version type. Valid values: SYS: system version. APP: application version |
| ClientType | integer | yes | The terminal type. Valid values: 1: hardware terminal. 2: software terminal. 3: secure browser plugin. 4: GuestOS application. 5: DingTalk… |
| Model | string | yes | The terminal model |
| MainBizType | string | no | The business type. Default value: enterprise |

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

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

## FAQ

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

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

### Can AI agents use the Alibaba Cloud Alibaba Cloud Workspace Terminal 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-wyota.

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