文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 实例管理/ 修改实例备注- UpdateGaussMySqlInstanceAlias
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改实例备注 - UpdateGaussMySqlInstanceAlias

功能介绍

修改实例备注。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:rename

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:modify
    • gaussdb:instance:rename

    -

URI

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

表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参数

参数

是否必选

参数类型

描述

alias

是

String

参数解释：

实例备注。

约束限制：

不涉及。

取值范围：

长度可在0~64个字符之间，由字母、数字、汉字、英文句号、下划线、中划线或空格组成，且空格不能出现在开头和结尾的位置。

默认取值：

不涉及。

响应参数

状态码：200

Success.

状态码： 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.

{ }

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理