docs
api
Cloud MongoDB Database(UDB NVMe)
ModifyUMongoDBBackupParam

Modify Instance Backup Strategy - ModifyUMongoDBBackupParam

Overview

Modify Instance Backup Strategy

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ModifyUMongoDBBackupParam.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
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
AutoBackupToggleWeekstringScheduled days for automatic backup (1-7), default is 3,7 (Wednesday, Sunday)No
AutoBackupToggleTimestringExpected start time range for automatic backup (00:00~23:59), default 5:00~6:00No
DisabledbooleanIs disabled, true: Disabled; false: EnabledNo

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

Example

Request Example

https://api.surfercloud.com/?Action=ModifyUMongoDBBackupParam
&Region=cn-zj
&Zone=cn-zj-01
&ClusterId=QFveBDkh
&AutoBackupToggleWeek=MabzTIqQ
&AutoBackupToggleTime=tVHYdJKq
&Disabled=true
&ProjectId=RpgESNrM

Response Example

{
  "Action": "ModifyUMongoDBBackupParamResponse",
  "Message": "awFOTaIs",
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved