1. 接口描述
本接口(CdbTdsqlRenameInstance)用于修改实例名称。
接口请求域名：tdsql.api.qcloud.com
2. 输入参数
以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，见公共请求参数页面。其中，此接口的Action字段为CdbTdsqlRenameInstance。
| 参数名称 | 是否必选 | 类型 | 描述 |
|---|---|---|---|
| cdbInstanceId | 是 | Int | 实例ID |
| name | 否 | String | 新的实例名 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Int | 公共错误码, 0表示成功，其他值表示失败。详见错误码页面的公共错误码。 |
| message | String | 模块错误信息描述，与接口相关。 |
| codeDesc | String | 逻辑错误码描述 |
| data | Array | 回的数据包字段 |
| data.id | Int | 受影响的实例ID |
4. 错误码表
以下是本接口常见的错误码，如果有不在此列的错误请查阅TDSQL错误码表
| 错误码 | 描述 |
|---|---|
| DbOperationFailed | DB内部失败 |
| InstanceNameIllegal | 更改实例名提供的实例名不合法 |
| NoInstanceFound | 实例不存在 |
5. 示例
输入
https://tdsql.api.qcloud.com/v2/index.php?Action=CdbTdsqlRenameInstance &<公共请求参数> &cdbInstanceId=40734 &name=newname
输出
{
"code":"0",
"message":"",
"codeDesc":"Success",
"data":{
"id":"40734"
}
}
