Skip to Content

ListTiDBClusterBackup - ListTiDBClusterBackup

Overview

ListTiDBClusterBackup

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ListTiDBClusterBackup.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
Limitintlen of data ,max 30No
Offsetintoffset default 0No

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
DataBackupDataBackupDataYes
TotalCountintbackup countNo

Data Model

BackupData

Field NameTypeDescription InformationRequired
BackupIdstringBackup IDYes
BackupStartTimeintBackup Start TimeYes
BackupEndTimeintBackup End TimeYes
BackupSizeintBackup file size, unit: MBYes
StatestringBackup StatusYes
BackupTypestringBackup MethodYes

Example

Request Example

https://api.ucloud-global.com/?Action=ListTiDBClusterBackup &Region=cn-zj &Id=MlaMfzgZ &Limit=7 &Offset=7

Response Example

{ "Action": "ListTiDBClusterBackupResponse", "BackupData": {}, "RetCode": 0, "TotalCount": 8 }