DescribeBackupTasks - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries backup tasks running in an ApsaraDB for MongoDB replica set or sharded cluster instance that uses cloud disks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dds:DescribeBackupTasks	none	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-2zeb2d64cb46xxxx
BackupJobId	integer	No	The ID of the backup task. Note If you call the CreateBackup operation to perform a manual backup task, you can set this parameter to the returned backup ID to query the backup progress of the task.	170034

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	D648B367-15B6-1B42-BD4B-47507C9CC****
BackupJobs	array<object>	The details of the backup task.
	object
BackupjobId	integer	The ID of the backup task.	170034
BackupSetStatus	string	The backup task status. Valid values: Scheduled: The backup task is in planning. Regular backup tasks that have not started are also in this state. Checking: The instance is being checked before the backup. Backuping: The backup task is in progress. Finished: The backup task is completed.	Scheduled
BackupStartTime	string	The start time of the backup task.	2024-01-16T11:04:56Z
Progress	string	The progress of the backup task. Unit: %. The progress is returned only for running backup tasks.	18%
JobMode	string	The backup mode. Valid values: Automated: automatic backup Manual: manual backup	Manual

Examples

Sample success responses

JSONformat

{
  "RequestId": "D648B367-15B6-1B42-BD4B-47507C9CC****",
  "BackupJobs": [
    {
      "BackupjobId": 170034,
      "BackupSetStatus": "Scheduled",
      "BackupStartTime": "2024-01-16T11:04:56Z",
      "Progress": "18%",
      "JobMode": "Manual"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-04-12	The response structure of the API has changed	View Change Details