ListTiDBClusterRestore - ListTiDBClusterRestore
Overview
ListTiDBClusterRestore
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is ListTiDBClusterRestore. | Yes |
| PublicKey | string | The user’s public key can be obtained from Console  | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See Region and Zone List | Yes |
| Id | string | service id | Yes |
| Limit | int | Limit | Yes |
| Offset | int | Offset | Yes |
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 |
| RestoreData | RestoreData | RestoreData | Yes |
Data Model
RestoreData
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RestoreId | string | Restored Id | Yes |
| SourceServiceId | string | Source Instance Id | Yes |
| TargetServiceId | string | Target Instance Id | Yes |
| BackupId | string | Backup Id | Yes |
| RestoreStartTime | int | Start Time of Recovery | Yes |
| RestoreEndTime | int | End time of recovery | Yes |
| State | string | Restoration Status | Yes |
Example
Request Example
https://api.ucloud-global.com/?Action=ListTiDBClusterRestore
&Region=cn-zj
&Id=HCHVCrcr
&Limit=8
&Offset=3Response Example
{
"Action": "ListTiDBClusterRestoreResponse",
"RestoreData": {},
"RetCode": 0
}