1. 接口描述
接口请求域名: tdmysql.tencentcloudapi.com 。
本接口(CreateStandbyDBInstances)提供批量创建灾备实例功能
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateStandbyDBInstance。 |
| Version | 是 | String | 公共参数,本接口取值:2021-11-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| PrimaryInstanceId | 是 | String | 主实例 id 示例值:"tdsql3-18b89f70" |
| Zone | 是 | String | 创建实例区域 示例值:"ap-guangzhou-1" |
| VpcId | 是 | String | 字符型vpcid 示例值:“vpc-o7ssr1vx” |
| SubnetId | 是 | String | 字符型subnetid 示例值:"subnet-s21doiba" |
| SpecCode | 是 | String | 购买规格 示例值:"mini" |
| Disk | 是 | Integer | 存储节点磁盘容量,单位GB 示例值:200 |
| StorageNodeNum | 是 | Integer | 存储节点数量 示例值:3 |
| Replications | 是 | Integer | 存储节点副本数量,最大为5,要求为奇数 示例值:3 |
| FullReplications | 否 | Integer | 全能型副本数 示例值:3 |
| InstanceName | 否 | String | 实例名称,要求长度1-60,允许包含中文、英文大小写、数字、-、_ 示例值:"my-instance" |
| TimeUnit | 否 | String | 时间单位,y:年,m:月,d:日 示例值:"m" |
| TimeSpan | 否 | Integer | 商品的时间大小 示例值:1 |
| StorageNodeCpu | 否 | Integer | 存储节点CPU核数 示例值:1 |
| StorageNodeMem | 否 | Integer | 存储节点内存大小 示例值:2 |
| PayMode | 否 | String | 付费模式,0表示按需计费/后付费,1表示预付费 示例值:0 |
| Vport | 否 | Integer | 自定义端口 示例值:3306 |
| Zones.N | 否 | Array of String | 多AZ可用区列表 示例值:["ap-chengdu-2"] |
| AutoVoucher | 否 | Boolean | 是否使用优惠卷 示例值:false |
| VoucherIds.N | 否 | Array of String | 优惠卷列表 示例值:["123fsase123"] |
| InstanceType | 否 | String | 实例架构类型,19.0.0 起支持 "hybrid"" 示例值:"hybrid" |
| StorageType | 否 | String | 磁盘类型,CLOUD_HSSD增强型SSD,CLOUD_TCS本地SSD盘 示例值:"CLOUD_HSSD" |
| ResourceTags.N | 否 | Array of ResourceTag | 标签键值对数组 |
| PrimaryInstanceRegion | 否 | String | 主实例地域 示例值:"ap-guangzhou" |
| InstanceMode | 否 | String | 实例模式,normal:标准型;enhanced:加强型 示例值:enhanced |
| Password | 否 | String | dbaadmin密码 示例值:9#si1ol0 |
| SecurityGroupIds.N | 否 | Array of String | 绑定安全组id列表 示例值:["sg-53stx92s"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例 ID 示例值:"tdsql3-267841d2" |
| FlowId | Integer | 任务ID 示例值:23 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建灾备
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateStandbyDBInstance
<公共请求参数>
{
"PrimaryInstanceId": "tdsql3-c5eab757",
"Zone": "ap-chengdu-1",
"VpcId": "vpc-jksnni36",
"SubnetId": "subnet-dz7wfk4r",
"SpecCode": "1c2g",
"Disk": 20,
"StorageNodeNum": 3,
"Replications": 3,
"FullReplications": 3,
"StorageNodeCpu": 1,
"StorageNodeMem": 2,
"PayMode": "0",
"Zones": [
"ap-chengdu-1"
],
"InstanceType": "hybrid",
"StorageType": "CLOUD_HSSD",
"PrimaryInstanceRegion": "ap-chengdu",
"InstanceMode": "enhanced"
}
输出示例
{
"Response": {
"FlowId": 4295043361,
"InstanceId": "tdsql3-6e462513",
"RequestId": "329c5c1e-b337-4733-a46b-543c3ed59435"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.StandbyRelationCheckError | 灾备关系检查错误 |
| FailedOperation.StandbyRelationParamError | 灾备参数错误 |
| OperationDenied.InstanceOperationNotAllowedError | 实例暂不支持此操作。 |