Help & DocumentationAPIsTencentDB for MongoDBBackup APIsDescribeBackupAccess

DescribeBackupAccess

Last updated: 2020-03-04 23:47:58

Contents：

1. API Description

Domain name for API request: mongodb.tencentcloudapi.com.

This API is used to get the permission to download a backup file. The specific backup file information can be obtained through the DescribeDBBackups API.

A maximum of 10 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: mongodb.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeBackupAccess.
Version Yes String Common parameter. The value used for this API: 2019-07-25.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
BackupName Yes String Name of the backup file for which to get the download permission

3. Output Parameters

Parameter Name Type Description
Region String Instance region
Bucket String The bucket where a backup file is located
Files Array of BackupFile Storage information of a backup file
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the permission to download an instance backup

Input Example

https://mongodb.tencentcloudapi.com/?Action=DescribeBackupAccess
&InstanceId=cmgo-f0vrx2v9
&BackupName=cmgo-f0vrx2v9_2019-09-02_04:49
&<Common request parameter>

Output Example

{
  "Bucket": "cmongo-cd-backup",
  "Files": [
    {
      "File": "cmongo_hotbackup/cmgo-f0vrx2v9_0/1567370984",
      "ReplicaSetId": "cmgo-f0vrx2v9_0"
    }
  ],
  "Region": "ap-chengdu",
  "RequestId": "7e108f10-d228-11e9-b27e-9500754d2540"
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter.PermissionDenied The current subaccount has no permission to perform this operation.
InvalidParameterValue.BackupFileNotFound The backup file was not found.
InvalidParameterValue.NotFoundInstance The instance was not found.