Docs
api
Cloud MongoDB Database(UDB NVMe)
GetUMongoDBBackupParam

Obtain Instance Backup Strategy - GetUMongoDBBackupParam

Overview

Obtain Instance Backup Strategy

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUMongoDBBackupParam.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 List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
ClusterIdstringInstance 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
DataSetBackupParamBackup Strategy InformationYes

Data Model

BackupParam

Field NameTypeDescription InformationRequired
ClusterIdstringInstance IDYes
AutoBackupToggleWeekstringScheduled Day(s) for Automatic Backup (1-7 represents Monday to Sunday, multiple days are separated by ’,’ e.g.: 3,7)No
AutoBackupToggleTimestringExpected time range for automatic backup (24-hour format, accurate to the minute, 00:00~23:59)No
AutoBackupCopiesintNumber of Automatic Backup CopiesNo
ManualBackupCopiesintNumber of Manual Backup CopiesNo
DisabledbooleanIs it disabled? (false: not disabled; true: disabled)No

Example

Request Example

https://api.dezai.com/?Action=GetUMongoDBBackupParam
&Region=cn-zj
&Zone=cn-zj-01
&ClusterId=DmBGvXyK
&ProjectId=VGopVKMd

Response Example

{
  "Action": "GetUMongoDBBackupParamResponse",
  "DataSet": {},
  "Message": "eBkJLfZH",
  "RetCode": 0
}