1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
添加serverless集群只读实例
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:AddServerlessRoInstances。 |
| Version | 是 | String | 公共参数,本接口取值:2019-01-07。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。 |
| ClusterId | 是 | String | 集群Id 示例值:cynosdbmysql-6gtlgm5l |
| MinCpu | 否 | Float | ro实例最小规格 示例值:0.5 |
| MaxCpu | 否 | Float | ro实例最大规格 示例值:2 |
| InstanceName | 否 | String | ro实例名称 示例值:S1-db-环境1 |
| VpcId | 否 | String | 所属VPC网络ID 示例值:vpc-1ptuei0b |
| SubnetId | 否 | String | 所属子网ID,如果设置了VpcId,则SubnetId必填 示例值:subnet-1tmw9t4o |
| Port | 否 | Integer | 新增RO组时使用的Port,取值范围为[0,65535) 示例值:3306 |
| SecurityGroupIds.N | 否 | Array of String | 安全组ID,新建只读实例时可以指定安全组 示例值:["sg-rgf3qgld"] |
| AutoPause | 否 | String | 是否自动暂停 枚举值:
示例值:yes |
| AutoPauseDelay | 否 | Integer | 自动暂停时间 单位:秒 示例值:60 |
| InstanceParams.N | 否 | Array of ModifyParamItem | 实例参数 |
| ParamTemplateId | 否 | Integer | 参数模板 示例值:12546 |
| RoCount | 否 | Integer | 新增的只读实例数量 示例值:3 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TranId | String | 冻结流水,一次开通一个冻结流水 注意:此字段可能返回 null,表示取不到有效值。 示例值:myTranId |
| DealNames | Array of String | 后付费订单号 注意:此字段可能返回 null,表示取不到有效值。 示例值:["182711111"] |
| ResourceIds | Array of String | 发货资源id列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:["cynosdbmysql-mwg712mm"] |
| BigDealIds | Array of String | 大订单号 注意:此字段可能返回 null,表示取不到有效值。 示例值:["202411073872"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加serverless只读实例
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddServerlessRoInstances
<公共请求参数>
{
"ClusterId": "cynosdbmysql-oi7mh90n",
"MinCpu": 1,
"MaxCpu": 2,
"InstanceName": "S1-db-环境1",
"Port": 3306,
"RoCount": 1
}
输出示例
{
"Response": {
"BigDealIds": null,
"DealNames": [
"20260509445022752472821"
],
"ResourceIds": [
"cynosdbmysql-ins-p1hpv1kk"
],
"TranId": "20260509445022752472831",
"RequestId": "29c45fc5-79bd-4794-91c0-50717b7978aa"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| OperationDenied.CamDeniedError | 权限校验失败。 |