TDSQL Boundless 创建实例

接口请求域名: tdmysql.tencentcloudapi.com 。本接口(CreateDBInstances)提供批量创建实例功能。

相关产品
TDSQL Boundless 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。你可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:CreateDBInstances。
Version 是 String 公共参数,本接口取值:2021-11-22。
Region 是 String 公共参数,详见产品支持的 地域列表。
VpcId 是 String 字符型vpcid示例值:“vpc-o7ssr1vx”
SubnetId 是 String 字符型subnetid示例值:"subnet-s21doiba"
SpecCode 是 String 购买规格示例值:"mini"
Disk 是 Integer 存储节点磁盘容量,单位GB示例值:200
StorageNodeNum 是 Integer 存储节点数量示例值:3
Replications 是 Integer 存储节点副本数量,最大为5,要求为奇数示例值:3
InstanceCount 是 Integer 创建实例个数,上限为10示例值:2
Zone 是 String 创建实例区域示例值:"ap-guangzhou-1"
FullReplications 否 Integer 全能型副本数量示例值:2
CreateVersion 否 String 创建实例版本,默认使用当前最新版本示例值:"0.0.1"
InstanceName 否 String 实例名称,要求长度1-60,允许包含中文、英文大小写、数字、-、_示例值:"my-instance"
ResourceTags.N 否 Array of ResourceTag 标签键值对数组
InitParams.N 否 Array of InstanceParam 初始化实例参数。比如:character_set_server(字符集,默认为utf8),lower_case_table_names(表名大小写敏感,0 – 敏感;1-不敏感,默认为0)
TimeUnit 否 String 时间单位,m:月示例值:"m"
TimeSpan 否 Integer 商品的时间大小示例值:1
StorageNodeCpu 否 Integer 存储节点CPU核数示例值:1
StorageNodeMem 否 Integer 存储节点内存大小示例值:2
PayMode 否 String 付费模式,0表示按需计费/后付费,1表示预付费示例值:0
MCNum 否 Integer 管控节点数量示例值:3
Vport 否 Integer 自定义端口示例值:3306
Zones.N 否 Array of String 多AZ可用区列表示例值:["ap-chengdu-2"]
AutoVoucher 否 Boolean 是否使用优惠卷示例值:false
VoucherIds.N 否 Array of String 优惠卷列表示例值:["free50"]
InstanceType 否 String 实例架构类型,separate:分离架构;hybrid:对等架构示例值:"hybrid"
StorageType 否 String 磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘示例值:"CLOUD_HSSD"
AZMode 否 Integer AZ模式,1:单AZ,2:多AZ非主AZ,3:多AZ主AZ示例值:2
InstanceMode 否 String 实例模式示例值:normal
TemplateId 否 String 参数模板id示例值:template-write-21.6.1
SQLMode 否 String 兼容模式,enum:MySQL,HBase示例值:MySQL
AutoScaleConfig 否 AutoScalingConfig SVLS 实例的ccu变配配置入参限制:同时传入 AutoScaleConfigs 时此参数不再生效
SecurityGroupIds.N 否 Array of String 绑定安全组列表示例值:["sg-lpowk2a"]
UserName 否 String root用户名,当前版本默认为dbaadmin,传值也会重置为dbaadmin示例值:dbaadmin
Password 否 String dbaadmin密码示例值:T****3
EncryptionEnable 否 Integer 是否开启透明加密,0:不开启,1:开启示例值:1
AutoScaleConfigs.N 否 Array of AutoScalingConfig SVLS 实例的自动变配相关限制入参限制:传入时 AutoScaleConfig 参数不再生效
PasswordComplexity 否 PasswordComplexity 密码复杂度

三、3. 输出参数

参数名称 类型 描述
InstanceIds Array of String 实例ID示例值:["tdsql3-267841d2"]
FlowId Integer 任务ID示例值:23
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

四、输入示例

POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstances
<公共请求参数>
{
"Zone": "ap-chengdu-1",
"VpcId": "vpc-jksnni36",
"SubnetId": "subnet-dz7wfk4r",
"SpecCode": "1c2g",
"Disk": 30,
"StorageNodeNum": 3,
"Replications": 3,
"InstanceCount": 1,
"CreateVersion": "21.2.0",
"InitParams": [
{
"Param": "character_set_server",
"Value": "utf8mb4"
},
{
"Param": "collation_server",
"Value": "utf8mb4_0900_ai_ci"
},
{
"Param": "lower_case_table_names",
"Value": "1"
}
],
"StorageNodeCpu": 1,
"StorageNodeMem": 2,
"Zones": [
"ap-chengdu-1"
],
"InstanceType": "hybrid",
"StorageType": "CLOUD_HSSD",
"InstanceMode": "enhanced",
"SQLMode": "MySQL",
"Password": "T********3"
}

五、输出示例

{
"Response": {
"FlowId": 4295045790,
"InstanceIds": [
"tdsql3-a473bad5"
],
"RequestId": "04bea82b-7915-4359-b050-6d31b7ca2613"
}
}

六、腾讯云 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

九、命令行工具

·Tencent Cloud CLI 3.0

十、6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
AuthFailure.CamAuthError CAM鉴权错误。
AuthFailure.CheckCamAuthError CAM鉴权请求参数检查失败。
AuthFailure.UnauthorizedOperation CAM鉴权失败。
DryRunOperation.AddTagDryrunError 绑定标签失败。
FailedOperation.CheckSupportActionError 当前实例版本不支持该接口。
FailedOperation.CreateFlowError 创建任务失败。
FailedOperation.DBCreateInstanceError 添加实例数据失败。
InvalidParameter.PasswordComplexityParamError 密码复杂度参数校验失败。
InvalidParameterValue.CheckDiskError 磁盘大小校验错误。
InvalidParameterValue.CheckInstanceVersionError 实例版本校验错误。
InvalidParameterValue.CheckNameError 名称校验失败。
InvalidParameterValue.CheckPasswdError 密码校验失败。
InvalidParameterValue.CheckSpecError 实例规格校验错误。
InvalidParameterValue.CheckVpcError vpc校验错误。
InvalidParameterValue.InvalidParameterValueError 参数错误。
InvalidParameterValue.NodeReplicasInvalidError 创建实例副本数不符合规范。
LimitExceeded.AddTagCountError 绑定tag数超限。
LimitExceeded.OutOfInstanceCntLimitError 批量创建实例数超过限制个数。
LimitExceeded.OutOfNodeReplicasLimitError 副本数超过限制。
LimitExceeded.OutOfSpecLimitError 规格超过限制。
赞 (0)
上一篇 4天前
下一篇 4天前