tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for MongoDB
    Documentation

    DescribeBackupAccess

    Last updated: 2022-04-21 10:14:34
    This document is currently invalid. Please refer to the documentation page of the product.

      1. API Description

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

      TencentDB will soon stop supporting this API as the backup download feature has been modified.

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

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

      We recommend you to use API Explorer
      Try it
      API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

      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 Params. The value used for this API: DescribeBackupAccess.
      Version Yes String Common Params. The value used for this API: 2019-07-25.
      Region Yes String Common Params. 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 parameters>

      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

      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.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy