All Products
Search
Document Center

ApsaraDB for Redis:DescribeBackupTasks

Last Updated:May 28, 2024

Queries the states of backup tasks for an ApsaraDB for Redis instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
kvstore:DescribeBackupTasksRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The details of the backup tasks.

r-bp1zxszhcgatnx****
BackupJobIdstringNo

The progress of the backup task in percentage.

1162****
JobModestringNo

The backup mode. Valid values:

  • Automated: automatic backup. You can call the DescribeBackupPolicy operation to query the automatic backup policy.
  • Manual: manual backup.
Note By default, the information about backup tasks in both modes is returned.
Manual

Response parameters

ParameterTypeDescriptionExample
object
InstanceIdstring

The ID of the instance.

r-bp1zxszhcgatnx****
RequestIdstring

The status of the backup task. Valid values:

  • NoStart: The backup task is not started.
  • Preparing: The backup task is being prepared.
  • Waiting: The backup task is pending.
  • Uploading: The system is uploading the backup file.
  • Checking: The system is checking the uploaded backup file.
  • Finished: The backup task is complete.
BB73740C-23E2-4392-9DA4-2660C74C****
BackupJobsobject []

The details of the backup tasks.

StartTimestring

The start time of the backup task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2021-01-05T19:24:00Z
Processstring

The progress of the backup task in percentage.

0
JobModestring

The backup mode. Valid values:

  • Automated: automatic backup
  • Manual: manual backup
Manual
BackupJobIDinteger

The ID of the backup task.

8491111
BackupProgressStatusstring

The state of the backup task. Valid values:

  • NoStart: The backup task is not started.
  • Preparing: The backup task is being prepared.
  • Waiting: The backup task is pending.
  • Uploading: The system is uploading the backup file.
  • Checking: The system is checking the uploaded backup file.
  • Finished: The backup task is completed.
Automated
NodeIdstring

The ID of the data node.

****
TaskActionstring

The type of the backup task. Valid values:

  • TempBackupTask: The backup task was manually performed.
  • NormalBackupTask: The backup task was automatically performed.
NormalBackupTask
AccessDeniedDetailobject

The following parameters are no longer used. Ignore the parameters.

AuthActionstring

This parameter is no longer used. Ignore this parameter.

_
AuthPrincipalDisplayNamestring

This parameter is no longer used. Ignore this parameter.

_
AuthPrincipalOwnerIdstring

This parameter is no longer used. Ignore this parameter.

_
AuthPrincipalTypestring

This parameter is no longer used. Ignore this parameter.

_
EncodedDiagnosticMessagestring

This parameter is no longer used. Ignore this parameter.

_
NoPermissionTypestring

This parameter is no longer used. Ignore this parameter.

_
PolicyTypestring

This parameter is no longer used. Ignore this parameter.

_

Examples

Sample success responses

JSONformat

{
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "BB73740C-23E2-4392-9DA4-2660C74C****",
  "BackupJobs": [
    {
      "StartTime": "2021-01-05T19:24:00Z",
      "Process": "0",
      "JobMode": "Manual",
      "BackupJobID": 8491111,
      "BackupProgressStatus": "Automated",
      "NodeId": "****",
      "TaskAction": "NormalBackupTask"
    }
  ],
  "AccessDeniedDetail": {
    "AuthAction": "_",
    "AuthPrincipalDisplayName": "_",
    "AuthPrincipalOwnerId": "_",
    "AuthPrincipalType": "_",
    "EncodedDiagnosticMessage": "_",
    "NoPermissionType": "_",
    "PolicyType": "_"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-03-26The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-11-13The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-11-06The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-07-25API Description Update. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Output ParametersThe response structure of the API has changed.