DescribeBackupTasks - PolarDB

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	No	DescribeBackupTasks	The operation that you want to perform. Set the value to DescribeBackupTasks.
DBClusterId	String	Yes	pc-***************	The ID of the cluster.
BackupJobId	String	No	11111111	The ID of the backup task.
BackupMode	String	No	Manual	The backup mode. Valid values: Automated: automatic backup Manual: manual backup

Response parameters


Parameter	Type	Example	Description
Items	Array of BackupJob		The details of the backup task.
BackupJob
BackupJobId	String	11111111	The ID of the backup task.
BackupProgressStatus	String	NoStart	The status of the backup task. Valid values: NoStart: The backup task has not been started. Preparing: The backup task is in the preparing phase. Waiting: The backup task is waiting to be started. Uploading: The backup task is uploading the backup file. Checking: The backup task is checking the uploaded backup file. Finished: The backup task is completed.
JobMode	String	Automated	The backup mode. Valid values: Automated: automatic backup Manual: manual backup
Process	String	0	The progress percentage of the backup task.
StartTime	String	2020-08-08T07:24:01Z	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.
TaskAction	String	NormalBackupTask	The type of the backup task. Valid values: TempBackupTask: The backup task is a temporary backup task. NormalBackupTask: The backup task is a common backup task.
RequestId	String	FA8C1EF1-E3D4-44D7-B809-823187******	The ID of the request.

Examples

Sample request

http(s)://polardb.aliyuncs.com/? Action=DescribeBackupTasks
&DBClusterId=pc-***************
&<Common request parameters>

Sample success responses

XML format

<DescribeBackupTasksResponse>
  <RequestId>FA8C1EF1-E3D4-44D7-B809-823187******</RequestId>
  <Items>
        <BackupJob>
              <JobMode>Automated</JobMode>
              <TaskAction>NormalBackupTask</TaskAction>
              <StartTime>2020-08-08T07:24:01Z</StartTime>
              <BackupProgressStatus>NoStart</BackupProgressStatus>
              <Process>0</Process>
              <BackupJobId>11111111</BackupJobId>
        </BackupJob>
  </Items>
</DescribeBackupTasksResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.