修改参数

最近更新时间:2017-12-14 10:59:41

1. 接口描述

本接口(ModifyCdbParams)用于修改云数据库实例的参数。
您还可以使用 查询参数列表 接口来获取实例的参数信息。
接口请求域名:cdb.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共参数 页面。其中,此接口的Action字段为ModifyCdbParams。

参数名称 是否必选 类型 描述
cdbInstanceIds.n String 一个或者多个实例ID,n表示从0开始的数组下标。实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用 查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
paramList.n (paramList 为数组,此处入参需要填写数组元素 ) String 每一个元素是name和value的组合。name是参数名,value是要修改成的值。

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误描述
data Array 返回的数据

其中, data 的参数构成如下:

参数名称 类型 描述
jobId Int 任务ID

4. 错误码表

以下错误码表仅列出了该接口的业务逻辑错误码。

错误代码 英文提示 错误描述
9003 InvalidParameter 参数错误
9006 InternalError 数据库内部错误
9016 InternalError 系统内部错误
9543 NameNotExists 实例名称不存在
9590 InternalFailure 任务数据库访问错误
9593 IncorrectInstanceStatus 实例状态异常

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=ModifyCdbParams
&<公共请求参数>
&cdbInstanceIds.0=cdb-c1nl9rpv
&paramList.0.name=connect_timeout
&paramList.0.value=11

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "jobId": 122
    }
}