Obtain Instance Backup Strategy - GetUMongoDBBackupParam

Overview

Obtain Instance Backup Strategy

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `GetUMongoDBBackupParam`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
Zone	string	Availability Zone. See Availability Zone List	Yes
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
ClusterId	string	Instance ID	Yes

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
DataSet	BackupParam	Backup Strategy Information	Yes

Field Name	Type	Description Information	Required
ClusterId	string	Instance ID	Yes
AutoBackupToggleWeek	string	Scheduled Day(s) for Automatic Backup (1-7 represents Monday to Sunday, multiple days are separated by ',' e.g.: 3,7)	No
AutoBackupToggleTime	string	Expected time range for automatic backup (24-hour format, accurate to the minute, 00:00~23:59)	No
AutoBackupCopies	int	Number of Automatic Backup Copies	No
ManualBackupCopies	int	Number of Manual Backup Copies	No
Disabled	boolean	Is it disabled? (false: not disabled; true: disabled)	No

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

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