# Upgrade db instance version - UpgradeUDBVersion

## Overview

Upgrade db instance version






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `UpgradeUDBVersion`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Availability Zone. See [Availability Zone List](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |No|
| **DBId** | string | DB instance resource ID |**Yes**|
| **DBSubVersion** | string | The minor version of the db needs to be upgraded. |**Yes**|
| **SwitchType** | string | Switch type, optional values are "immediately" and "customize", representing immediate switch and custom switch time respectively. Custom switch time requires filling in SwitchStartTime and SwitchEndTime. |**Yes**|
| **SwitchStartTime** | int | This value is a unix timestamp, representing the start time of switching instances. |No|
| **SwitchEndTime** | int | This value is a Unix timestamp, representing the expected end time of the instance switch. |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|




## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=UpgradeUDBVersion
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=yHTQpoge
&DBId=ReURijJx
&SwitchType=mPVLFeeV
&SwitchStartTime=2
&SwitchEndTime=2
&PrepareStartTime=8
&DBSubVersion=BPNBKREw
```

### Response Example
    
```json
{
  "Action": "UpgradeUDBVersionResponse",
  "Message": "mvUErSmN",
  "RetCode": 0
}
```