Docs
api
Cloud MongoDB Database(UDB NVMe)
DescribeUMongoDBBackupURL

Get Instance Backup Download Link - DescribeUMongoDBBackupURL

Overview

Get Instance Backup Download Link

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeUMongoDBBackupURL.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
ClusterIdstringCluster IDYes
BackupIdstringFile Backup IDNo
PackageIdintPackage IDNo
ValidTimeintBackup link expiration time (in seconds)No

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
InternetAddressstringPublic Network Address for Backup FilesYes
IntranetAddressstringIntranet Address of Backup FileYes

Example

Request Example

https://api.dezai.com/?Action=DescribeUMongoDBBackupURL
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=DatUQmzF
&ClusterId=cDNCLXDU
&BackupId=reAlkmik
&ValidTime=1
&PackageId=3

Response Example

{
  "Action": "DescribeUMongoDBBackupURLResponse",
  "InternetAddress": "DYnKJjGA",
  "IntranetAddress": "eZNhwqZl",
  "RetCode": 0
}