All Products
Search
Document Center

PolarDB:DescribeBackupTasks

Last Updated:Nov 07, 2023

Queries the backup tasks of a PolarDB cluster.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeBackupTasksREAD
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

pc-***************
BackupJobIdstringNo

The ID of the backup task.

11111111
BackupModestringNo

The backup mode. Valid values:

  • Automated
  • Manual
Manual

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

FA8C1EF1-E3D4-44D7-B809-823187******
Itemsobject []

The details of the backup task.

StartTimestring

The time when the backup task started. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

2020-08-08T07:24:01Z
Processstring

The progress of the backup task in percentage.

0
BackupJobIdstring

The ID of the backup task.

11111111
JobModestring

The backup mode. Valid values:

  • Automated
  • Manual
Automated
BackupProgressStatusstring

The state of the backup task. Valid values:

  • NoStart
  • Preparing
  • Waiting
  • Uploading
  • Checking
  • Finished
NoStart
TaskActionstring

The type of the backup task. Valid values:

  • TempBackupTask: The backup task is an adhoc backup task.
  • NormalBackupTask: The backup task is a common backup task.
NormalBackupTask

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
400InvalidBackupMode.MalformedThe specified parameter BackupMode is not valid.The specified BackupMode parameter is invalid.

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