# 修改实例备注信息 - UpdateInstanceAlias
#### 功能介绍
修改指定数据库实例的备注信息。
- 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。
- 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=UpdateInstanceAlias)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                       | 访问级别  | 资源类型（\*为必须） | 条件键                                                                            | 别名                  | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:updateRemark | write | instance    | g:EnterpriseProjectId g:ResourceTag/\<tag-key\> | rds:instance:modify | -      |
   
#### URI
- URI格式 PUT /v3/{project_id}/instances/{instance_id}/alias
  

- 参数说明
  表1参数说明 
  | 名称          | 是否必选 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
  |:---|:---|:---|
  | project_id  | 是    | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                 |
  | instance_id | 是    | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  
 
#### 请求消息
表2参数说明 
| 名称    | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| alias | 否    | String | **参数解释：** 实例备注。 **约束限制**： 不涉及。 **取值范围**： 长度可在0\~64个字符之间，由字母、数字、汉字、英文句号、下划线、中划线组成。 不传该参数，或参数值为空，将会删除原备注。 **默认取值**： 不涉及。 |
   
#### 请求示例
修改实例的备注信息。
```
PUT https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/alias
{
     "alias": "alias-test"
}
```
#### 响应消息
- 正常响应要素说明
  表3要素说明 
  | 名称   | 参数类型   | 说明                                                                                                                                                                                                                          |
  |:---|:---|:---|
  | resp | String | **参数解释**： 调用结果。 **取值范围**： successful：调用正常。 |
     
  

- 正常响应要素说明
  ```
  {
      "resp": "successful"
  }
  ```
  
 
- 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
  
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。