
# 数据库补丁升级-UpgradingtheDatabasePatch
#### 功能介绍
升级数据库补丁版本。
#### 接口约束
- 冻结实例、异常实例，无法升级补丁版本。
- 实例中存在异常节点，无法升级补丁版本。
- 请根据实例详情查询接口返回结果中的"patch_available"字段判断是否支持升级。
- 请选择在业务低峰期进行升级。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=UpgradeDatabaseVersion)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                 | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                              | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dds:instance:upgradeDatabaseVersion | write | instance    | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | -  | -      |
     
  
 
#### URI
- URI格式 POST /v3/{project_id}/instances/{instance_id}/db-upgrade
  
- URI样例
  https://dds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/db-upgrade
  表1路径参数 
  | 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
  |:---|:---|:---|:---|
  | project_id  | 是    | String | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                         |
  | instance_id | 是    | String | **参数解释：** 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  
 
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表3请求Body参数 
| 参数           | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| upgrade_mode | 否    | String  | **参数解释：** 升级模式。 **约束限制：** 不涉及。 **取值范围：** - minimized_interrupt_time：表示为中断时间最短优先模式，升级过程对业务影响相对较小的升级方式。  - minimized_upgrade_time：表示为升级时长最短优先模式，升级过程时长相对较快的升级方式。   **默认取值：** "minimized_interrupt_time"。 |
| is_delayed   | 否    | Boolean | **参数解释：** 实例是否在[可维护时间窗](https://support.huaweicloud.com/api-dds/dds_api_0137.html)内自动升级。 **约束限制：** 不涉及。 **取值范围：** - true: 延迟升级，实例将在可维护时间窗内自动升级。  - false: 立即升级。   **默认取值：** false。                |
   
#### 响应参数
表4响应Body参数 
| 参数     | 参数类型   | 描述                                                                                                                           |
|:---|:---|:---|
| job_id | String | **参数解释：** 任务ID。 **取值范围：** 不涉及。 |
   
#### 请求示例
- 副本集实例升级数据库补丁版本
  ```
  { 
    "upgrade_mode" : "minimized_interrupt_time" 
  }
  ```
  
- 实例在可维护时间窗内自动升级数据库补丁版本
  ```
  { 
     "is_delayed" : true 
   }
  ```
  
 
#### 响应示例
```
{ 
  "job_id" : "55e166d2-83ad-425f-b887-3503de03dc9b" 
}
```
#### 状态码
详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。
#### 错误码
详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。
