# upgrade tidb cluster - UpgradeTiDBCluster

## Overview

Upgrade Prepaid tidb Cluster






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `UpgradeTiDBCluster`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.sigcalcloud.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 [Region and Zone List](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the [GetProjectList API](/docs/api/summary/get_project_list) |No|
| **Id** | string | Instance ID |**Yes**|
| **DbVersion** | string | Target Version Number |**Yes**|
| **StartTime** | int | StartTime |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.sigcalcloud.com/?Action=UpgradeTiDBCluster
&Region=cn-zj
&ProjectId=kHBotDxd
&Id=RAfRasXi
&DbVersion=KZreNHMI
&StartTime=4
```

### Response Example
    
```json
{
  "Action": "UpgradeTiDBClusterResponse",
  "Message": "WAICZFkr",
  "RetCode": 0
}
```