1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
查询Serverless弹性扩容计划
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeClusterServerlessScalePlans。 |
| 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-dbsbgqxg |
| InstanceIds.N | 否 | Array of String | 实例列表 示例值:["cynosdbmysql-ins-dbsbgqxg", "cynosdbmysql-ins-dxsbgqxg"] |
| PolicyType | 否 | String | 策略类型. PolicyTypePeriodScale - 周期弹性 示例值:PolicyTypePeriodScale |
| PlanId | 否 | Integer | 计划ID 示例值:12354 |
| Limit | 否 | Integer | 分页数量限制,默认10 示例值:10 |
| Offset | 否 | Integer | 查询偏移,默认0 示例值:0 |
| ExpectedStartTime | 否 | String | 按计划预期执行时间为条件查询的开始时间点,包含当前时间 示例值:2025-07-01 10:00:00 |
| ExpectedEndTime | 否 | String | 按计划预期执行时间为条件查询的结束时间点,包含当前时间 示例值:2025-07-30 10:00:00 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 计划总数 示例值:30 |
| ServerlessScalePlans | Array of ClusterServerlessScalePlan | 策略列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询计划
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterServerlessScalePlans
<公共请求参数>
{
"ClusterId": "cynosdbmysql-xdbsbsgg",
"PlanId": 12541
}
输出示例
{
"Response": {
"TotalCount": 1,
"ServerlessScalePlans": [
{
"PlanId": 1231,
"ClusterId": "cynosdbmysql-xbhshsbh",
"ObjectInstance": "cynosdbmysql-ins-xbhshsbh",
"PolicyId": "cynosdbmysql-spd-rye0gd5b",
"PolicyType": "PolicyTypePeriodScale",
"SourceMinCpu": "1.0",
"SourceMaxCpu": "8.0",
"TargetMinCpu": "2.0",
"TargetMaxCpu": "4.0",
"ExpectedStartTime": "2025-12-01 00:12:00",
"ExpectedEndTime": "2025-12-01 00:20:00",
"Status": "success",
"ScaleTaskId": 131,
"FailReason": "",
"ResetTaskId": 0
}
],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。