DescribeBackupTasks - PolarDB - Alibaba Cloud Documentation Center

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

polardb:DescribeBackupTasks

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-***************
BackupJobId	string	No	The backup job ID.	11111111
BackupMode	string	No	The backup mode. Valid values: Automated: An automatic backup. Manual: A manual backup.	Manual

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	FA8C1EF1-E3D4-44D7-B809-823187******
Items	object
BackupJob	array<object>	The details of the backup job.
	object
StartTime	string	The time when the backup job started. The time is in Coordinated Universal Time (UTC) and the format is `YYYY-MM-DDThh:mm:ssZ`.	2020-08-08T07:24:01Z
Process	string	The progress of the backup job in percentage.	0
BackupJobId	string	The backup job ID.	11111111
JobMode	string	The backup mode. Valid values: Automated: An automatic backup. Manual: A manual backup.	Automated
BackupProgressStatus	string	The status of the backup job. Valid values: NoStart: The job has not started. Preparing: The job is being prepared. Waiting: The job is waiting. Uploading: The backup is being uploaded. Checking: The backup is being checked. Finished: The job is complete.	NoStart
TaskAction	string	The type of the backup job. Valid values: TempBackupTask: A temporary backup job. NormalBackupTask: A normal backup job.	NormalBackupTask

Examples

Success response

JSON format

{
  "RequestId": "FA8C1EF1-E3D4-44D7-B809-823187******",
  "Items": {
    "BackupJob": [
      {
        "StartTime": "2020-08-08T07:24:01Z",
        "Process": "0",
        "BackupJobId": "11111111",
        "JobMode": "Automated",
        "BackupProgressStatus": "NoStart",
        "TaskAction": "NormalBackupTask"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
400	InvalidBackupMode.Malformed	The specified parameter BackupMode is not valid.	The specified BackupMode parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.