Get Backup Download Address - GetUPgSQLBackupURL
Overview
Get Backup Download Address
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetUPgSQLBackupURL . | 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 |
Request Parameters
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 |
InstanceID | string | DB Instance Id | Yes |
BackupID | string | Backup Id | Yes |
Response Field
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 |
BackupPath | string | Public network address of the DB instance backup file | Yes |
InnerBackupPath | string | Intranet address of the DB instance backup file | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=GetUPgSQLBackupURL
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=SRZamenq
&InstanceID=tOwREWKR
&BackupID=bvGRtoZD
Response Example
{
"Action": "GetUPgSQLBackupURLResponse",
"BackupPath": "wdvxVEkT",
"InnerBackupPath": "cpDbdGMy",
"Message": "CKvcXQGc",
"RetCode": 0
}