DescribeBackupTasks - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeBackupTasks

none

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D648B367-15B6-1B42-BD4B-47507C9CC****
BackupJobs	array<object>
	object	The details of the backup job.
BackupjobId	string	The ID of the backup job.	170034
BackupSetStatus	string	The status of the backup job. Scheduled: The backup job is scheduled. This includes regular backup jobs that have not started. Checking: The instance is being checked before the backup. Backuping: The backup is in progress. Finished: The backup is complete.	Scheduled
BackupStartTime	string	The start time of the backup.	2024-01-16T11:04:56Z
Progress	string	The backup progress in percentage. The progress is displayed only for running backup jobs.	18%
JobMode	string	The backup mode. Valid values: Automated: automatic backup. Manual: manual backup.	Manual

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.