DescribeBackupDownloadTask

Last updated: 2025-12-03 10:42:15

DescribeBackupDownloadTask

Last updated: 2025-12-03 10:42:15

1. API Description

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

This API is used to query information about the backup download task.

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 Params. The value used for this API: DescribeBackupDownloadTask.
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. Log in to the TencentDB for MongoDB console, and copy the instance ID from the instance list.
BackupName	No	String	Specifies the backup file name for filtering download tasks of the specified file. The DescribeDBBackups API can be called to obtain the backup file name.
StartTime	No	String	Specifies the task within the query time range, and StartTime specifies the start time. If not specified, there are no limitations on the start time by default.
EndTime	No	String	Specifies the task within the query time range, and EndTime specifies the end time. If not specified, there are no limitations on the end time by default.
Limit	No	Integer	Number of entries returned for this query. Value range: 1–100. The default value is 20.
Offset	No	Integer	Specifies the number of pages returned for this query. The default value is 0.
OrderBy	No	String	Sorting field. - createTime: sort by the creation time of the backup download task. The default value is createTime. - finishTime: sort by the completion time of the backup download task.
OrderByType	No	String	Sorting method. - asc: ascending order. - desc: descending order. The default value is desc.
Status.N	No	Array of Integer	Specifies the task status for filtering download tasks. If this parameter is not configured, tasks of all status types will be returned. - 0: wait for execution. - 1: downloading. - 2: download completed. - 3: download failed. - 4: wait for retry.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	All entries that meet the query conditions.
Tasks	Array of BackupDownloadTask	Download task list.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying a Backup Download Task

Input Example

POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupDownloadTask
<Common request parameters>

{
    "InstanceId": "cmgo-fdzf****",
    "Status": [
        "2"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "c7c0c495-4826-4938-a6d7-32146cad2632",
        "Tasks": [
            {
                "BackupDesc": "Set daily scheduled automatic backup in the system background.",
                "BackupMethod": 0,
                "BackupName": "cmgo-fdzf****_2025-09-23 22:03",
                "BackupSize": 5747378,
                "Bucket": "sh-backup-remote-125758****",
                "CreateTime": "2025-09-24 10:58:55",
                "Percent": 100,
                "Region": "ap-shanghai",
                "ReplicaSetId": "cmgo-fdzf******",
                "Status": 2,
                "TimeSpend": 1,
                "Url": "https://sh-backup-remote-tar-**************"
            }
        ],
        "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

Tencent Cloud CLI 3.0

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 sub-account has no permission to perform this operation.
InvalidParameterValue.BackupFileNotFound	The backup file was not found.
InvalidParameterValue.NotFoundInstance	The instance was not found.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud