1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
修改serverless策略
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyServerlessStrategy。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-07。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: 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 。 |
ClusterId | 是 | String | serverless集群id 示例值:cynosdbmysql-8vcxoq75 |
AutoPause | 否 | String | 集群是否自动暂停,可选范围 示例值:no |
AutoPauseDelay | 否 | Integer | 集群自动暂停的延迟,单位秒,可选范围[600,691200],默认600 示例值:100 |
AutoScaleUpDelay | 否 | Integer | 该参数暂时无效 示例值:200 |
AutoScaleDownDelay | 否 | Integer | 该参数暂时无效 示例值:300 |
MinCpu | 否 | Float | cpu最小值,可选范围参考DescribeServerlessInstanceSpecs接口返回 示例值:0.25 |
MaxCpu | 否 | Float | cpu最大值,可选范围参考DescribeServerlessInstanceSpecs接口返回 示例值:2 |
MinRoCpu | 否 | Float | 只读实例cpu最小值,可选范围参考DescribeServerlessInstanceSpecs接口返回 示例值:0.25 |
MaxRoCpu | 否 | Float | 只读cpu最大值,可选范围参考DescribeServerlessInstanceSpecs接口返回 示例值:2 |
MinRoCount | 否 | Integer | 只读节点最小个数 示例值:3 |
MaxRoCount | 否 | Integer | 只读节点最大个数 示例值:3 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowId | Integer | 异步流程id 示例值:1008300 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改serverless策略
修改serverless策略
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyServerlessStrategy
<公共请求参数>
{
"AutoPause": "no",
"AutoScaleUpDelay": 200,
"AutoPauseDelay": 100,
"MinCpu": 0.25,
"MaxCpu": 2,
"ClusterId": "cynosdbmysql-8vcxoq75",
"AutoScaleDownDelay": 300
}
输出示例
{
"Response": {
"FlowId": 1008300,
"RequestId": "c3da7958-23e8-11eb-8e52-525400b7dd5a"
}
}
示例2 变更serverless策略
调整主节点
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyServerlessStrategy
<公共请求参数>
{
"ClusterId": "cynosdbmysql-92oecwyv",
"MinCpu": 2,
"MaxCpu": 2
}
输出示例
{
"Response": {
"FlowId": 917319,
"RequestId": "a7ef1e81-e306-45fd-ab3d-37a6ae7ecf96"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DatabaseAccessError | 数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.OperationFailedError | 操作失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.ServerlessSetStrategyError | 修改策略失败。 |
InternalError.DbOperationFailed | 查询数据库失败。 |
InternalError.SystemError | 系统内部错误。 |
InternalError.UnknownError | 未知的内部错误。 |
InvalidParameterValue.ClusterNotFound | 未查询到集群。 |
InvalidParameterValue.DbModeNotServerlessError | 集群类型必须为serverless。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
InvalidParameterValue.ParamError | 参数错误。 |
OperationDenied.ClusterStatusDeniedError | 集群当前状态不允许该操作。 |
ResourceNotFound.ClusterNotFoundError | 集群不存在。 |
UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |