修改实例名称

最近更新时间:2018-09-28 15:00:22

1. 接口描述

接口请求域名: mariadb.tencentcloudapi.com 。

本接口(ModifyDBInstanceName)用于修改云数据库实例的名称。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:mariadb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyDBInstanceName
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
InstanceId String 待修改的实例 ID。形如:tdsql-ow728lmc,可以通过 DescribeDBInstances 查询实例详情获得。
InstanceName String 新的实例名称。允许的字符为字母、数字、下划线、连字符和中文。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 修改实例名称

输入示例

https://mariadb.tencentcloudapi.com/?Action=ModifyDBInstanceName
&InstanceId=tdsql-fdpjf5zh
&InstanceName=newname
&<公共请求参数>

输出示例

{
  "Response": {
    "InstanceId": "tdsql-fdpjf5zh",
    "RequestId": "6a6b0cc7-c183-4e50-bf19-b83aa9fe77fc"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

命令行工具

6. 错误码

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

错误码 描述
InternalError.CamAuthFailed CAM鉴权请求失败。
InternalError.DbOperationFailed 查询数据库失败。
InvalidParameter.GenericParameterError 参数合法性校验错误。
InvalidParameterValue.InstanceNameIllegal 非法的实例名称。
ResourceNotFound.NoInstanceFound 找不到指定的数据库实例。
UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。