修改实例名称
功能介绍
修改实例名称。
须知：
该接口计划于2025-03-31下线，建议及时切换到新接口修改实例名称。
URI
PUT https://{
Endpoint
}/gaussdb/v3/{
project_id
}/instances/{
instance_id
}/name
表1 参数说明
名称
是否必选
说明
project_id
是
参数解释：
租户在某一Region下的项目ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
只能由英文字母、数字组成，且长度为32个字符。
默认取值：
不涉及。
instance_id
是
实例ID。
请求参数
表2 请求参数
名称
是否必选
参数类型
说明
name
是
String
实例名称。用于表示实例的名称，同一租户下，同类型的实例名可重名。
取值范围：4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。
响应参数
表3 响应参数
名称
参数类型
说明
job_id
String
修改实例名称的任务ID。
请求示例
https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/name
{
"name": "instance-name"
}
响应示例
{
"job_id": "2b414788a6004883a02390e2eb0ea227"
}
状态码
-
正常
202
-
异常
请参见状态码。
错误码
请参见错误码。
