文档首页> 云数据库 GaussDB (for openGauss)> API参考> API（推荐）> 实例管理> 修改实例名称
更新时间：2022-05-19 GMT+08:00
查看PDF
分享

修改实例名称

功能介绍

修改实例名称。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/name

  • URI样例

    https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/name

    • 参数说明
      表1 参数说明

      名称

      是否必选

      说明

      project_id

      是

      租户在某一region下的project ID。

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

      instance_id

      是

      实例ID，严格匹配UUID规则。

请求消息

  • 参数说明
    表2 参数说明

    名称

    是否必选

    参数类型

    说明

    name

    是

    String

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

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

响应消息

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

    名称

    参数类型

    说明

    job_id

    String

    修改实例名称的任务ID。
  • 正常响应样例
    {
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}
  • 异常响应

    请参见异常请求结果。

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理
分享：

    相关文档

    相关产品

close