更新时间：2024-05-31 GMT+08:00
修改实例名称
调试
您可以在API Explorer中调试该接口。
URI
PUT /mysql/v3/{project_id}/instances/{instance_id}/name
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户在某一region下的project ID。 获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID，严格匹配UUID规则。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围：
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
name |
是 |
String |
实例名称。 长度最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
job_id |
String |
修改实例名称的任务id |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
修改实例名称
POST https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name
{
"name" : "gaussdb-name"
}
响应示例
状态码： 200
Success.
{
"job_id" : "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1"
}
状态码
状态码 |
描述 |
|---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。
