# Tencent Cloud Cloud Virtual Desktop API

> Tencent Cloud Cloud Virtual Desktop API on Apizie: 48 endpoints (Associate Security Group, Bind Instances, Create Command Task, Create Data Disk, …) 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://apizie.tech/v1/cloud:tencent-cvd/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:tencent-cvd`
- Category: Cloud
- Status: byok
- Source: https://www.tencentcloud.com/document/api
- Page: https://apizie.tech/api/cloud/tencent-cvd
- OpenAPI: https://apizie.tech/api/cloud/tencent-cvd/openapi.json

Tencent Cloud API 3.0 for Cloud Virtual Desktop (cvd). Every call is signed with TC3-HMAC-SHA256 using your SecretId and SecretKey.

## Endpoints

### Associate Security Group
`POST https://apizie.tech/v1/cloud:tencent-cvd/associate-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |

### Bind Instances
`POST https://apizie.tech/v1/cloud:tencent-cvd/bind-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| UserIds | array | yes |  |
| InstanceIds | array | yes |  |
| InstanceType | string | yes |  |
| InstanceRegion | string | no |  |

### Create Command Task
`POST https://apizie.tech/v1/cloud:tencent-cvd/create-command-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Command | string | yes |  |
| Type | string | yes |  |
| InstanceIds | array | yes |  |
| RunAsBoundUser | boolean | no |  |
| RunForeground | boolean | no |  |

### Create Data Disk
`POST https://apizie.tech/v1/cloud:tencent-cvd/create-data-disk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| DiskType | string | yes |  |
| DiskSize | integer | yes |  |
| SnapShotId | string | no |  |

### Create Domain Control Policy
`POST https://apizie.tech/v1/cloud:tencent-cvd/create-domain-control-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Name | string | no |  |
| Description | string | no |  |
| Type | string | no |  |
| DetailSet | array | no |  |
| IpDetailSet | array | no |  |
| InstanceIds | array | no |  |

### Create Image
`POST https://apizie.tech/v1/cloud:tencent-cvd/create-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| ImageName | string | yes |  |
| Description | string | no |  |
| DataDiskIds | array | no |  |

### Create Instances
`POST https://apizie.tech/v1/cloud:tencent-cvd/create-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceType | string | yes |  |
| SystemDisk | object | yes |  |
| ImageId | string | yes |  |
| VirtualPrivateCloud | object | yes |  |
| InstanceName | string | no |  |
| InstanceCount | integer | no |  |
| DataDisks | array | no |  |
| ChargeType | string | no |  |
| ChargePrepaid | object | no |  |
| DryRun | boolean | no |  |
| AnonymousAccess | boolean | no |  |
| SecurityGroups | array | no |  |
| PoolId | string | no |  |
| DomainControlPolicies | array | no |  |
| Tags | array | no |  |
| Zone | string | no |  |

### Create Policy
`POST https://apizie.tech/v1/cloud:tencent-cvd/create-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Name | string | yes |  |
| PolicyInfoList | array | yes |  |
| Description | string | no |  |
| UserIds | array | no |  |

### Delete Command Tasks
`POST https://apizie.tech/v1/cloud:tencent-cvd/delete-command-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Filters | array | yes |  |

### Delete Domain Control Policy
`POST https://apizie.tech/v1/cloud:tencent-cvd/delete-domain-control-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PolicyId | string | no |  |

### Delete Images
`POST https://apizie.tech/v1/cloud:tencent-cvd/delete-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageIds | array | yes |  |

### Describe Command Tasks
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-command-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| Filters | array | no |  |

### Describe Images
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PageNumber | integer | yes |  |
| PageSize | integer | yes |  |
| Filters | array | no |  |

### Describe Instance Fetch Msg
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-instance-fetch-msg` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UserId | string | no |  |
| DesktopName | string | no |  |
| Force | boolean | no |  |
| IsInternal | boolean | no |  |

### Describe Instance Graph Data
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-instance-graph-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| StartTime | string | yes |  |
| EndTime | string | yes |  |

### Describe Instance Login Msg
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-instance-login-msg` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| UserId | string | no |  |
| DesktopName | string | no |  |
| Force | boolean | no |  |
| IsInternal | boolean | no |  |

### Describe Instance Monitor Data
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-instance-monitor-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Instances | array | yes |  |
| NameSpace | string | yes |  |
| MetricName | string | yes |  |
| Period | integer | no |  |
| StartTime | string | no |  |
| EndTime | string | no |  |
| SpecifyStatistics | integer | no |  |

### Describe Instance Region Distribution
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-instance-region-distribution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Regions | array | no |  |
| Types | array | no |  |
| UserId | string | no |  |

### Describe Instances
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PageNumber | integer | yes |  |
| PageSize | integer | yes |  |
| Filters | array | no |  |

### Describe Instances Bind Status
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-instances-bind-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| InstanceRegion | string | no |  |

### Describe Instances Status
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-instances-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |

### Describe Invocation Detail
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-invocation-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| InvokeId | string | yes |  |
| OutputLinesOffset | integer | no |  |
| OutputLinesLimit | integer | no |  |
| MergeOutputLines | boolean | no |  |

### Describe Invocations
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-invocations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |

### Describe Policy Detail
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-policy-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| Filters | array | no |  |

### Describe Security Groups
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-security-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| SecurityGroupRegion | string | no |  |

### Describe Snapshots
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-snapshots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| SnapshotRegion | string | yes |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| Filters | array | no |  |

### Describe Usage
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| StartTime | integer | yes |  |
| EndTime | integer | yes |  |
| PageSize | integer | no |  |
| PageNumber | integer | no |  |
| QueryKey | string | no |  |
| Filters | array | no |  |
| SortType | integer | no |  |

### Describe Users
`POST https://apizie.tech/v1/cloud:tencent-cvd/describe-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Keyword | string | no |  |
| PageNumber | integer | no |  |
| PageSize | integer | no |  |
| DepartmentId | string | no |  |

### Disassociate Security Group
`POST https://apizie.tech/v1/cloud:tencent-cvd/disassociate-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |

### Modify Disk Configuration
`POST https://apizie.tech/v1/cloud:tencent-cvd/modify-disk-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| NewSystemDisk | object | no |  |
| NewDataDisks | array | no |  |

### Modify Image Attrs
`POST https://apizie.tech/v1/cloud:tencent-cvd/modify-image-attrs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| ImageId | string | yes |  |
| Attrs | array | yes |  |

### Modify Instance Basic Attribute
`POST https://apizie.tech/v1/cloud:tencent-cvd/modify-instance-basic-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| AttributeInfoList | array | yes |  |

### Modify Instances Type
`POST https://apizie.tech/v1/cloud:tencent-cvd/modify-instances-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| InstanceType | string | yes |  |
| ChargeType | string | yes |  |

### Modify Instances Vpc
`POST https://apizie.tech/v1/cloud:tencent-cvd/modify-instances-vpc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| VpcId | string | yes |  |
| SubnetId | string | yes |  |
| DnsServerSet | array | no |  |

### Reboot Instances
`POST https://apizie.tech/v1/cloud:tencent-cvd/reboot-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| InstanceRegion | string | yes |  |
| Force | boolean | no |  |
| PreLogin | boolean | no |  |

### Remove Data Disks
`POST https://apizie.tech/v1/cloud:tencent-cvd/remove-data-disks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | no |  |
| DataDiskIds | array | no |  |

### Remove Policy
`POST https://apizie.tech/v1/cloud:tencent-cvd/remove-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PolicyId | string | yes |  |

### Renew Instances
`POST https://apizie.tech/v1/cloud:tencent-cvd/renew-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| ChargePrepaid | object | no |  |

### Reset Instances
`POST https://apizie.tech/v1/cloud:tencent-cvd/reset-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| ImageId | string | yes |  |
| InstanceRegion | string | yes |  |
| IsUnbind | boolean | yes |  |

### Run Command
`POST https://apizie.tech/v1/cloud:tencent-cvd/run-command` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| Content | string | yes |  |
| Type | string | yes |  |
| WaitUntilDone | boolean | no |  |
| ContentEncoding | string | no |  |
| MergeOutputLines | boolean | no |  |
| RunAs | string | no |  |
| RunForeground | boolean | no |  |

### Start Instances
`POST https://apizie.tech/v1/cloud:tencent-cvd/start-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| InstanceRegion | string | yes |  |

### Stop Command Tasks
`POST https://apizie.tech/v1/cloud:tencent-cvd/stop-command-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| Filters | array | yes |  |

### Stop Instances
`POST https://apizie.tech/v1/cloud:tencent-cvd/stop-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| InstanceRegion | string | yes |  |
| Force | boolean | no |  |

### Stop Invocation
`POST https://apizie.tech/v1/cloud:tencent-cvd/stop-invocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceId | string | yes |  |
| InvokeId | string | yes |  |

### Stop Session
`POST https://apizie.tech/v1/cloud:tencent-cvd/stop-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceRegion | string | yes |  |
| HostName | string | yes |  |
| IsDisconnect | boolean | yes |  |
| UserId | string | no |  |

### Terminate Instances
`POST https://apizie.tech/v1/cloud:tencent-cvd/terminate-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceIds | array | yes |  |
| DestroyImmediately | boolean | no |  |

### Unbind Instances
`POST https://apizie.tech/v1/cloud:tencent-cvd/unbind-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| InstanceRegion | string | yes |  |
| BindInfos | array | yes |  |

### Update Policy
`POST https://apizie.tech/v1/cloud:tencent-cvd/update-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-TC-Region | string | no | Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley |
| PolicyId | string | yes |  |
| Name | string | yes |  |
| Description | string | yes |  |
| PolicyInfoList | array | yes |  |
| BindUserIds | array | no |  |
| RemoveUserIds | array | no |  |

## Example
```
curl "https://apizie.tech/v1/cloud:tencent-cvd/associate-security-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Tencent Cloud Cloud Virtual Desktop API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:tencent-cvd/associate-security-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Tencent Cloud Cloud Virtual Desktop API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:tencent-cvd.

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