1. 接口描述
接口请求域名: tcaplusdb.tencentcloudapi.com 。
本接口用于创建TcaplusDB集群
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCluster。 |
Version | 是 | String | 公共参数,本接口取值:2019-08-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
IdlType | 是 | String | 集群数据描述语言类型,如:PROTO ,TDR 或MIX 示例值:TDR |
ClusterName | 是 | String | 集群名称,可使用中文或英文字符,最大长度32个字符 示例值:gz测试TDR |
VpcId | 是 | String | 集群所绑定的私有网络实例ID,形如:vpc-f49l6u0z 示例值:vpc-kppg4pm1 |
SubnetId | 是 | String | 集群所绑定的子网实例ID,形如:subnet-pxir56ns 示例值:subnet-3sww53pa |
Password | 是 | String | 集群访问密码,必须是a-zA-Z0-9的字符,且必须包含数字和大小写字母 示例值:84ea4cbf06573ED |
ResourceTags.N | 否 | Array of TagInfoUnit | 集群标签列表 |
Ipv6Enable | 否 | Integer | 集群是否开启IPv6功能 示例值:0 |
ServerList.N | 否 | Array of MachineInfo | 独占集群占用的svr机器 |
ProxyList.N | 否 | Array of MachineInfo | 独占集群占用的proxy机器 |
ClusterType | 否 | Integer | 集群类型1共享2独占 示例值:1 |
AuthType | 否 | Integer | 密码认证类型,0 静态认证, 1 签名认证 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ClusterId | String | 集群ID 示例值:6179109757 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建集群Cluster
新创建TcaplusDB集群
输入示例
https://tcaplusdb.tencentcloudapi.com/?Action=CreateCluster
&IdlType=TDR
&ClusterName=gz测试TDR
&VpcId=vpc-kppg4pm1
&SubnetId=subnet-3sww53pa
&Password=84ea4cbf06573ED
&<公共请求参数>
输出示例
{
"Response": {
"ClusterId": "6179109757",
"RequestId": "8f1cc454-4a80-4ed3-a6c3-b7df2b0e8ec7"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameterValue.InvalidClusterName | 集群名称不合法。 |
InvalidParameterValue.UnsupportIdlType | 不支持的应用数据描述类型。 |
ResourceInsufficient.BalanceError | 余额不足。 |
ResourceInsufficient.NoAvailableCluster | 没有可用的集群资源。 |
ResourceInsufficient.NoEnoughVipInVPC | 私有网络中没有可用的vip资源。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.DuplicateClusterName | 集群名称重复。 |