更新时间:2025-07-29 GMT+08:00

修改实例名称

功能介绍

修改实例名称。

URI

PUT /v3/{project_id}/instances/{instance_id}/name

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

实例名称。

约束限制

同一租户下,同类型的实例名可重名。

取值范围

最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。

默认取值

不涉及。

is_modify_node_name

String

参数解释

是否同步修改节点名称。

约束限制

不涉及。

取值范围

  • true:同步修改节点名称。

  • false:不同步修改节点名称。

默认取值

true。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释:

修改实例名称的任务ID。

取值范围

不涉及。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

修改实例的名称为“gaussdb-name”。

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name
{
  "name" : "gaussdb-name"
}

响应示例

状态码: 200

Success.

{
  "job_id" : "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1"
}

状态码

请参见状态码

错误码

请参见错误码