Skip to Content
Distributed NewSQL Database(TiDB)StartTiDBClusterRestore

StartTiDBClusterRestore - StartTiDBClusterRestore

Overview

StartTiDBClusterRestore

Definition

Public Parameters

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

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See Region and Zone ListYes
BackupIdstringBackupIdYes
Idstring目标实例的服务IdYes

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

Example

Request Example

https://api.ucloud-global.com/?Action=StartTiDBClusterRestore &Region=cn-zj &BackupId=WjspwUvO &Id=ltdnOqWw

Response Example

{ "Action": "StartTiDBClusterRestoreResponse", "Message": "rJfLhaPY", "RestoreId": "zPcTqOJC", "RetCode": 0, "ServiceId": "mPMyGJFZ" }