文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 实例管理> 修改实例备注
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF

修改实例备注

功能介绍

修改实例备注。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

alias

是

String

实例备注。

长度可在0~64个字符之间，由字母、数字、汉字、英文句号、下划线、中划线组成。

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

将实例备注修改为“Test_alias”。

PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/alias
{
  "alias" : "Test_alias"
}

响应示例

状态码： 200

Success.

{ }

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理