Skip to Content
Distributed NewSQL Database(TiDB)ListTiDBClusterRestore

ListTiDBClusterRestore - ListTiDBClusterRestore

Overview

ListTiDBClusterRestore

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ListTiDBClusterRestore.Yes
PublicKeystringThe user’s public key can be obtained from Console Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See Region and Zone ListYes
Idstringservice idYes
LimitintLimitYes
OffsetintOffsetYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
RestoreDataRestoreDataRestoreDataYes

Data Model

RestoreData

Field NameTypeDescription InformationRequired
RestoreIdstringRestored IdYes
SourceServiceIdstringSource Instance IdYes
TargetServiceIdstringTarget Instance IdYes
BackupIdstringBackup IdYes
RestoreStartTimeintStart Time of RecoveryYes
RestoreEndTimeintEnd time of recoveryYes
StatestringRestoration StatusYes

Example

Request Example

https://api.ucloud-global.com/?Action=ListTiDBClusterRestore &Region=cn-zj &Id=HCHVCrcr &Limit=8 &Offset=3

Response Example

{ "Action": "ListTiDBClusterRestoreResponse", "RestoreData": {}, "RetCode": 0 }