云数据库 MySQL 修改实例参数-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cdb.tencentcloudapi.com 。

本接口(ModifyInstanceParam)用于修改云数据库实例的参数。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyInstanceParam。
Version	是	String	公共参数，本接口取值：2017-03-20。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceIds.N	是	Array of String	实例短 ID 列表。示例值：["cdb-atjl8gns\r\n"]
ParamList.N	否	Array of Parameter	要修改的参数列表。每一个元素是 Name 和 CurrentValue 的组合。Name 是参数名，CurrentValue 是要修改成的值。
TemplateId	否	Integer	模板id，ParamList和TemplateId必须至少传其中之一示例值：99
WaitSwitch	否	Integer	执行参数调整任务的方式，默认为 0。支持值包括：0 - 立刻执行，1 - 时间窗执行；当该值为 1 时，每次只能传一个实例（InstanceIds数量为1）示例值：0
NotSyncRo	否	Boolean	参数是否同步到主实例下的只读实例。true 为不同步，false 为同步。默认为 false。示例值：true
NotSyncDr	否	Boolean	参数是否同步到主实例下的灾备实例。true 为不同步，false 为同步。默认为 false。示例值：true

3. 输出参数

参数名称	类型	描述
AsyncRequestId	String	异步任务 ID，可用于查询任务进度。示例值：38265324-dd030463-3d46a793-4a0420b1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改实例参数

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceParam
<公共请求参数>

{
    "NotSyncDr": true,
    "NotSyncRo": true,
    "ParamList": [
        {
            "CurrentValue": "xx",
            "Name": "xx"
        }
    ],
    "TemplateId": 0,
    "InstanceIds": [
        "cdb-atjl8gns"
    ],
    "WaitSwitch": 0
}

输出示例

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "AsyncRequestId": "38265324-dd030463-3d46a793-4a0420b1"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
CdbError.DatabaseError	后端数据库错误。
CdbError.TaskError	后端任务错误。
InternalError.DatabaseAccessError	数据库内部错误。
InternalError.HttpError	Http请求异常。
InternalError.InternalHttpServerError	请求执行异常。
InternalError.ParamError	参数错误。
InternalError.TaskFrameError	异步任务错误。
InternalError.UnknownError	未知错误。
InvalidParameter	参数错误。
InvalidParameter.ExceptionParam	异常参数。
InvalidParameter.InstanceNotFound	实例不存在。
InvalidParameterValue.DataConvertError	数据转换失败。
InvalidParameterValue.InvalidParameterValueError	参数值无效。
OperationDenied	操作被拒绝。
OperationDenied.InstanceTaskStatusError	实例任务状态异常。
ResourceNotFound.InstanceNotFundError	该实例不存在。

修改实例参数

本页目录：