1. 接口描述
接口请求域名: cdwdoris.tencentcloudapi.com 。
通过API创建集群
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateInstanceNew。 |
Version | 是 | String | 公共参数,本接口取值:2021-12-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Zone | 是 | String | 可用区 |
FeSpec | 是 | CreateInstanceSpec | FE规格 |
BeSpec | 是 | CreateInstanceSpec | BE规格 |
HaFlag | 是 | Boolean | 是否高可用 |
UserVPCId | 是 | String | 用户VPCID |
UserSubnetId | 是 | String | 用户子网ID |
ProductVersion | 是 | String | 产品版本号 |
ChargeProperties | 是 | ChargeProperties | 付费类型 |
InstanceName | 是 | String | 实例名字 |
DorisUserPwd | 是 | String | 数据库密码 |
Tags.N | 否 | Array of Tag | 标签列表 |
HaType | 否 | Integer | 高可用类型: 0:非高可用(只有1个FE,FeSpec.CreateInstanceSpec.Count=1), 1:读高可用(至少需部署3个FE,FeSpec.CreateInstanceSpec.Count>=3,且为奇数), 2:读写高可用(至少需部署5个FE,FeSpec.CreateInstanceSpec.Count>=5,且为奇数)。 示例值:0 |
CaseSensitive | 否 | Integer | 表名大小写是否敏感,0:敏感;1:不敏感,以小写进行比较;2:不敏感,表名改为以小写存储 示例值:0 |
EnableMultiZones | 否 | Boolean | 是否开启多可用区 示例值:true |
UserMultiZoneInfos | 否 | NetworkInfo | 开启多可用区后,用户的所有可用区和子网信息 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowId | String | 流程ID |
InstanceId | String | 实例ID |
ErrorMsg | String | 错误信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 集群创建示例
创建集群
输入示例
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstanceNew
<公共请求参数>
{
"InstanceName": "test-按量-hazk2节点",
"Zone": "ap-beijing-2",
"FeSpec": {
"SpecName": "S_4_16_H",
"Count": 3,
"DiskSize": 200
},
"BeSpec": {
"SpecName": "S_4_16_H",
"Count": 3,
"DiskSize": 1000
},
"HaFlag": true,
"UserVPCId": "vpc-8visjoh9",
"UserSubnetId": "subnet-03ij1dki",
"ProductVersion": "1.2",
"DorisUserPwd": "ujA7xa2*1",
"ChargeProperties": {
"ChargeType": "POSTPAID_BY_HOUR"
}
}
输出示例
{
"Response": {
"InstanceId": "cdwdoris-aijqera",
"FlowId": "1231",
"RequestId": "lweinasd-28kamasd-xasdas",
"ErrorMsg": ""
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。