1. 接口描述
接口请求域名： cvd.tencentcloudapi.com 。
创建云桌面实例
默认接口请求频率限制：20次/秒。
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 |
必选 |
类型 |
描述 |
| Action |
是 |
String |
公共参数，本接口取值：CreateInstances。 |
| Version |
是 |
String |
公共参数，本接口取值：2020-11-04。 |
| Region |
是 |
String |
公共参数，详见产品支持的 地域列表。 |
| InstanceType |
是 |
String |
实例类型。 S3L.MEDIUM4: 云桌面-标准S3_2核4G S3L.LARGE8: 云桌面-标准S3_4核8G S3L.LARGE16: 云桌面-标准S3_4核16G S3L.2XLARGE16: 云桌面-标准S3_8核16G S1L.LARGE8：云桌面-标准S1_4核8G S1L.LARGE16：标准S1_4核16G S2L.2XLARGE16：标准S2_8核16G G1L.LARGE16：图形G1_4核16G G1L.2XLARGE32：图形G1_8核32G G1L.4XLARGE64：图形G1_16核64G G2L.LARGE24: 云桌面-图形G2_6核24G G2L.3XLARGE58: 云桌面-图形G2_14核58G G2L.3XLARGE44: 云桌面-图形G2_12核44G G3L.LARGE16: 云桌面-图形G3_4核16G G3L.5XMEDIUM40: 云桌面-图形G3_10核40G G3L.5XLARGE80: 云桌面-图形G3_20核80G G4L.5XMEDIUM40: 云桌面-图形G4_10核40G G4L.11XMEDIUM80: 云桌面-图形G4_22核80G G4L.11XLARGE160: 云桌面-图形G4_44核160G G5L.5XMEDIUM40: 云桌面-图形G5_10核40G G5L.5XLARGE80: 云桌面-图形G5_22核80G G5L.21XMEDIUM160: 云桌面-图形G5_42核160G G5L.21XLARGE320: 云桌面-图形G5_84核320G G6L.8XLARGE96: 云桌面-图形G6_32核96G G6L.16XLARGE192: 云桌面-图形G6_64核192G G6L.24XLARGE288: 云桌面-图形G6_96核288G G6L.32XLARGE384: 云桌面-图形G6_128核384G G6L.48XLARGE576: 云桌面-图形G6_192核576G G6L.64XLARGE768: 云桌面-图形G6_256核768G G6L.96XLARGE1152: 云桌面-图形G6_384核1152G G6L.96XLARGE1536: 云桌面-图形G6_384核1536G G6L.192XLARGE2304: 云桌面-图形G6_768核2304G G6Ls.8XLARGE96: 云桌面-图形G6s_32核96G G6Ls.16XLARGE192: 云桌面-图形G6s_64核192G G6Ls.24XLARGE288: 云桌面-图形G6s_96核288G G6Ls.32XLARGE384: 云桌面-图形G6s_128核384G G6Ls.48XLARGE576: 云桌面-图形G6s_192核576G G6Ls.64XLARGE768: 云桌面-图形G6s_256核768G G6Ls.96XLARGE1152: 云桌面-图形G6s_384核1152G G6Ls.96XLARGE1536: 云桌面-图形G6s_384核1536G G6Ls.192XLARGE2304: 云桌面-图形G6s_768核2304G G8L.8XLARGE96: 云桌面-图形G8_32核96G G8L.12XLARGE192: 云桌面-图形G8_48核192G G8L.16XLARGE192: 云桌面-图形G8_64核192G G8L.24XLARGE384: 云桌面-图形G8_96核384G G8L.32XLARGE384: 云桌面-图形G8_128核384G G8L.48XLARGE768: 云桌面-图形G8_192核768G G8L.64XLARGE768: 云桌面-图形G8_256核768G G8L.96XLARGE1536: 云桌面-图形G8_384核1536G G9L.12XLARGE192: 云桌面-图形G9_48核192G G9L.24XLARGE384: 云桌面-图形G9_96核384G G9L.48XLARGE768: 云桌面-图形G9_192核768G G9L.96XLARGE1536: 云桌面-图形G9_384核1536G 枚举值： - S3L.MEDIUM4： 云桌面-标准S3_2核4G
- S3L.LARGE8： 云桌面-标准S3_4核8G
- S3L.LARGE16： 云桌面-标准S3_4核16G
- S3L.2XLARGE16： 云桌面-标准S3_8核16G
- S1L.LARGE8： 云桌面-标准S1_4核8G
- S1L.LARGE16： 标准S1_4核16G
- S2L.2XLARGE16： 标准S2_8核16G
- G1L.LARGE16： 图形G1_4核16G
- G1L.2XLARGE32： 图形G1_8核32G
- G1L.4XLARGE64： 图形G1_16核64G
- G2L.LARGE24： 云桌面-图形G2_6核24G
- G2L.3XLARGE58： 云桌面-图形G2_14核58G
- G2L.3XLARGE44： 云桌面-图形G2_12核44G
- G3L.LARGE16： 云桌面-图形G3_4核16G
- G3L.5XMEDIUM40： 云桌面-图形G3_10核40G
- G3L.5XLARGE80： 云桌面-图形G3_20核80G
- G4L.5XMEDIUM40： 云桌面-图形G4_10核40G
- G4L.11XMEDIUM80： 云桌面-图形G4_22核80G
- G4L.11XLARGE160： 云桌面-图形G4_44核160G
- G5L.5XMEDIUM40： 云桌面-图形G5_10核40G
- G5L.5XLARGE80： 云桌面-图形G5_22核80G
- G5L.21XMEDIUM160： 云桌面-图形G5_42核160G
- G5L.21XLARGE320： 云桌面-图形G5_84核320G
- G6L.8XLARGE96： 云桌面-图形G6_32核96G
- G6L.16XLARGE192： 云桌面-图形G6_64核192G
- G6L.24XLARGE288： 云桌面-图形G6_96核288G
- G6L.32XLARGE384： 云桌面-图形G6_128核384G
- G6L.48XLARGE576： 云桌面-图形G6_192核576G
- G6L.64XLARGE768： 云桌面-图形G6_256核768G
- G6L.96XLARGE1152： 云桌面-图形G6_384核1152G
- G6L.96XLARGE1536： 云桌面-图形G6_384核1536G
- G6L.192XLARGE2304： 云桌面-图形G6_768核2304G
- G6Ls.8XLARGE96： 云桌面-图形G6s_32核96G
- G6Ls.16XLARGE192： 云桌面-图形G6s_64核192G
- G6Ls.24XLARGE288： 云桌面-图形G6s_96核288G
- G6Ls.32XLARGE384： 云桌面-图形G6s_128核384G
- G6Ls.48XLARGE576： 云桌面-图形G6s_192核576G
- G6Ls.64XLARGE768： 云桌面-图形G6s_256核768G
- G6Ls.96XLARGE1152： 云桌面-图形G6s_384核1152G
- G6Ls.96XLARGE1536： 云桌面-图形G6s_384核1536G
- G6Ls.192XLARGE2304： 云桌面-图形G6s_768核2304G
- G8L.8XLARGE96： 云桌面-图形G8_32核96G
- G8L.12XLARGE192： 云桌面-图形G8_48核192G
- G8L.16XLARGE192： 云桌面-图形G8_64核192G
- G8L.24XLARGE384： 云桌面-图形G8_96核384G
- G8L.32XLARGE384： 云桌面-图形G8_128核384G
- G8L.48XLARGE768： 云桌面-图形G8_192核768G
- G8L.64XLARGE768： 云桌面-图形G8_256核768G
- G8L.96XLARGE1536： 云桌面-图形G8_384核1536G
- G9L.12XLARGE192： 云桌面-图形G9_48核192G
- G9L.24XLARGE384： 云桌面-图形G9_96核384G
- G9L.48XLARGE768： 云桌面-图形G9_192核768G
- G9L.96XLARGE1536： 云桌面-图形G9_384核1536G
示例值：S1.LARGE8 |
| SystemDisk |
是 |
Disk |
系统盘信息 |
| ImageId |
是 |
String |
镜像ID
示例值：img-xxx |
| VirtualPrivateCloud |
是 |
VirtualPrivateCloud |
私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。 |
| InstanceName |
否 |
String |
实例显示名称。 如果该字段为空，则采用默认格式：云桌面型号+月日+三位随机数+镜像ID。 购买多台实例，如果指定模式串{R:x}，表示生成数字[x, x+n-1]，其中n表示购买实例的数量，例如server_{R:3}，购买1台时，实例显示名称为server_3；购买2台时，实例显示名称分别为server_3，server_4。支持指定多个模式串{R:x}。 购买多台实例，如果不指定模式串，则在实例显示名称添加后缀1、2...n，其中n表示购买实例的数量，例如server_，购买2台时，实例显示名称分别为server_1，server_2。 最多支持60个字符（包含模式串）。
示例值：myComputer |
| InstanceCount |
否 |
Integer |
购买实例数量。取值范围[1,50]。默认为1
示例值：5 |
| DataDisks.N |
否 |
Array of Disk |
数据盘信息。目前只支持一块数据盘。 |
| ChargeType |
否 |
String |
实例计费类型。 PREPAID：预付费，即包年包月 POSTPAID_BY_HOUR：按小时后付费默认为PREPAID
示例值：PREPAID |
| ChargePrepaid |
否 |
ChargePrepaid |
预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 |
| DryRun |
否 |
Boolean |
是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和库存。如果检查通过，则返回的错误码为DryRunOperation；如果返回其他错误码表示检查没有通过； false（默认）：发送正常请求，通过检查后直接创建实例
示例值：false |
| AnonymousAccess |
否 |
Boolean |
允许绑定用户前的匿名访问。默认值：false。
示例值：false |
| SecurityGroups.N |
否 |
Array of String |
关联的安全组ID列表
示例值：["sg-sdh123b"] |
| PoolId |
否 |
String |
桌面池ID
示例值：pol-1234 |
| DomainControlPolicies.N |
否 |
Array of String |
域名管控策略ID
示例值：["domain-sdjh36g"] |
| Tags.N |
否 |
Array of Tag |
标签，最多10个 |
| Zone |
否 |
String |
可用区
示例值：ap-shanghai-5 |
3. 输出参数
| 参数名称 |
类型 |
描述 |
| InstanceIdSet |
Array of String |
当通过本接口来创建实例时会返回该参数，表示一个或多个实例ID。返回实例ID列表并不代表实例创建成功。通过进一步查询返回的InstancesSet中对应实例的ID的状态来判断创建是否完成；如果实例状态由“准备中”变为“正在运行”，则为创建成功。
示例值：["cdi-1vogaxgk"] |
| RequestId |
String |
唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建实例
输入示例
POST / HTTP/1.1
Host: cvd.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances
<公共请求参数>
{
"InstanceType": "S1L.LARGE8",
"SystemDisk": {
"DiskType": "CLOUD_SSD",
"DiskSize": 50
},
"ImageId": "img-40kyb7sr",
"VirtualPrivateCloud": {
"VpcId": "vpc-1f99gocg",
"SubnetId": "subnet-a2f56ctb"
},
"ChargeType": "POSTPAID_BY_HOUR"
}
输出示例
{
"Response": {
"InstanceIdSet": [
"cdi-th8c2dtr6c4tjqy"
],
"RequestId": "11212ab3-2a95-4f46-9644-019bb237e6e2"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 |
描述 |
| AuthFailure |
CAM签名/鉴权错误。 |
| DryRunOperation |
DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation.DealCheckFailed |
订单校验没有通过。 |
| FailedOperation.InsufficientBalance |
账户余额不足。 |
| FailedOperation.SystemError |
信令执行时发生错误,建议重试。 |
| InvalidParameterValue |
参数取值错误。 |
| InvalidParameterValue.Disk |
硬盘相关的参数错误。 |
| InvalidParameterValue.Image |
镜像相关的参数错误。 |
| InvalidParameterValue.LimitExceeded |
参数取值错误，超过单次允许操作的最大数量。 |
| LimitExceeded.InstanceQuota |
超过允许的配置数量。 |
| LimitExceeded.ParallelOperation |
并行执行的操作过多。 |
| ResourceInsufficient.SpecifiedInstanceType |
指定类型实例库存不足。 |
| UnauthorizedOperation.ServiceNotActivated |
尚未开通该项服务，请先开通服务。 |
| UnsupportedOperation |
操作不支持。 |
| UnsupportedOperation.InstanceState |
实例当前的状态下不支持该操作。 |
