DescribeBackupDownloadTask

Last updated: 2021-10-22 15:24:34

1. API Description

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

This API is used to query backup download task information.

A maximum of 20 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 parameter. The value used for this API: DescribeBackupDownloadTask.
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", which is the same as the instance ID displayed in the TencentDB console
BackupName No String The name of a backup file with download tasks to be queried
StartTime No String The start time of the query period. Tasks whose start time and end time fall within the query period will be queried. If it is left empty, the start time can be any time earlier than the end time.
EndTime No String The end time of the query period. Tasks whose start time and end time fall within the query period will be queried. If it is left empty, the end time can be any time later than the start time.
Limit No Integer The maximum number of results returned per page. Value range: 1-100. Default value: 20.
Offset No Integer Offset for pagination. Default value: 0.
OrderBy No String The field used to sort the results. Valid values: createTime (default), finishTime.
OrderByType No String Sort order. Valid values: asc, desc (default).
Status.N No Array of Integer The status of the tasks to be queried. Valid values: 0 (waiting for execution), 1 (downloading), 2 (downloaded), 3 (download failed), 4 (waiting for retry). If it is left empty, tasks in any status will be returned.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of results
Tasks Array of BackupDownloadTask The list of download tasks
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying backup download task information

Input Example

https://mongodb.tencentcloudapi.com/?Action=DescribeBackupDownloadTask
&InstanceId=cmgo-dygv1rnp
&Status.0=2
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "c41c0c46-7d5a-49b9-832a-557880c1e9ef",
    "Tasks": [
      {
        "BackupName": "cmgo-dygv1rnp_2021-03-26 10:44",
        "BackupSize": 844,
        "CreateTime": "2021-03-26 10:47:37",
        "Percent": 100,
        "ReplicaSetId": "cmgo-dygv1rnp_0",
        "Status": 2,
        "TimeSpend": 0,
        "Url": "https://mognodb-backup-test-tar-1251937656.cos.ap-guangzhou.myqcloud.com/cmgo-dygv1rnp_2021-03-26%2010%3A44%2Fcmgo-dygv1rnp_0.tar?q-sign-algorithm=sha1&q-ak=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&q-sign-time=1616726859%3B1616813259&q-key-time=1616726859%3B1616813259&q-header-list=host&q-url-param-list=&q-signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
      }
    ],
    "TotalCount": 1
  }
}

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
AuthFailure CAM signature/authentication error
InternalError Internal error
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.