文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 实例管理/ 修改实例名称
更新时间：2024-04-01 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改实例名称

功能介绍

修改实例名称。

该接口计划于2025-03-31下线，建议及时切换到新接口修改实例名称。

URI

  • URI格式

    PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/name

  • URI样例

    PUT https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/name

  • 参数说明
    表1 参数说明

    名称

    参数类型

    是否必选

    说明

    project_id

    String

    是

    租户在某一Region下的project ID。

    获取方法请参见获取项目ID。

    instance_id

    String

    是

    实例ID。

请求消息

表2 参数说明

名称

参数类型

是否必选

说明

name

String

是

实例名称。

用于表示实例的名称，同一租户下，同类型的实例名可重名。

取值范围：4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。
  • 请求样例 
    {
  "name": "gaussdb-name"
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    job_id

    String

    修改实例名称的任务ID。
  • 正常响应样例 
    {
"job_id": "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理