Queries the backup tasks of an instance.
Operation description
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ClientToken | string | No | Specifies the client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. | ETnLKlblzczshOTUbOCzxxxxxxx |
Flag | string | No | A reserved parameter. | None |
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5xxxxxxx |
BackupJobId | integer | No | The ID of the backup task. | 4762614 |
BackupMode | string | No | The backup mode. Valid values:
| Automated |
BackupJobStatus | string | No | The status of the backup task. Valid values:
By default, this operation returns backup tasks in both states. | NoStart |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "90496720-2319-42A8-87CD-FCE4DF95EBED",
"Items": {
"BackupJob": [
{
"Process": "25",
"BackupJobId": "4762614",
"BackupStatus": "NoStart",
"JobMode": "Automated",
"BackupProgressStatus": "NoStart",
"BackupId": "346650271",
"TaskAction": "NormalBackupTask"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InternalFailure | Internal failure, retry later. | The request failed. Please try again later. |
400 | InvalidParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter. |
400 | ReadDBInstanceNotSupport | The operation is not permitted due to type of the instance. | - |
400 | InvalidParameters.Format | Specified parameter is not valid | The operation failed. The values of some parameters are invalid. |
404 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | The instance ID cannot be found. |
404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | The RDS instance cannot be found, is deleted, or does not support the operation. |
For a list of error codes, visit the Service error codes.