Skip to Content
Distributed NewSQL Database(TiDB)StartTiDBClusterBackup

StartTiDBClusterBackup - StartTiDBClusterBackup

Overview

StartTiDBClusterBackup

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is StartTiDBClusterBackup.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
BackupTsstringbackup timeNo
BackupFilterstringbackup filtersNo

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
BackupIdstringBackupIdYes
ServiceIdstringServiceIdYes

Example

Request Example

https://api.ucloud-global.com/?Action=StartTiDBClusterBackup &Region=cn-zj &Id=MTMlHCZS &BackupTs=RsgWlzIz &BackupFilter=amGEuxPV

Response Example

{ "Action": "StartTiDBClusterBackupResponse", "BackupId": "hkkRKWCk", "Message": "HzaIrmcD", "RetCode": 0, "ServiceId": "qpAsVRbU" }