# ListTiDBClusterBackup - ListTiDBClusterBackup

## Overview

ListTiDBClusterBackup






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListTiDBClusterBackup`.                      | **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**|
| **Id** | string | service id |**Yes**|
| **Limit** | int | len of data ，max 30 |No|
| **Offset** | int | offset default 0 |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|
| **Data** | [*BackupData*](#backupdata) | BackupData |**Yes**|
| **TotalCount** | int | backup count |No|

#### Data Model


#### BackupData

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **BackupId** | string | Backup ID |**Yes**|
| **BackupStartTime** | int | Backup Start Time |**Yes**|
| **BackupEndTime** | int | Backup End Time |**Yes**|
| **BackupSize** | int | Backup file size, unit: MB |**Yes**|
| **State** | string | Backup Status |**Yes**|
| **BackupType** | string | Backup Method |**Yes**|

## Example

### Request Example
    
```
https://api.sigcalcloud.com/?Action=ListTiDBClusterBackup
&Region=cn-zj
&Id=MlaMfzgZ
&Limit=7
&Offset=7
```

### Response Example
    
```json
{
  "Action": "ListTiDBClusterBackupResponse",
  "BackupData": {},
  "RetCode": 0,
  "TotalCount": 8
}
```