All Products
Search
Document Center

Database Backup:DescribeFullBackupList

Last Updated:Nov 09, 2022

Queries full backup tasks.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:DescribeFullBackupListRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup schedule.

1ibh2XXXXXXX
PageSizeintegerNo

The number of entries to return on each page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.

30
PageNumintegerNo

The number of the page to return. The value must be a positive integer. Default value: 0.

1
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageTypebooleanNo

Specifies whether to return the storage class. Default value: true.

true
BackupSetIdstringNo

The ID of the backup set.

1ibh2XXXXXXX
StartTimestamplongNo

The beginning of the time range to query.

1609430400
EndTimestamplongNo

The end of the time range to query.

1638288000

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
PageNuminteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

636BC118-6080-4119-A6B5-C199CEC1037D
ErrCodestring

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
TotalPagesinteger

The total number of returned pages.

1
TotalElementsinteger

The total number of full backup tasks.

1
PageSizeinteger

The number of entries returned on each page.

10
Itemsarray

The details of full backup tasks.

object
FinishTimelong

The timestamp when the full backup task ended, such as 1554560477000.

1583741466000
BackupStatusstring

The status of the backup task. Valid values:

  • schedule: The backup task is being initialized.
  • running: The backup task is running.
  • finish: The backup task is complete.
  • stop: The backup task failed.
  • pause: The backup task is stopped.
finish
SourceEndpointIpPortstring

The endpoint that is used to connect to the database.

100.X.X.10:33204
CreateTimelong

The timestamp when the full backup task started, such as 1554560477000.

1583740896000
ErrMessagestring

The error message.

NULL
BackupObjectsstring

The backup object.

[{\"DBName\":\"test\"}]
EndTimelong

The end time of the backup task, such as 1554560477000.

1583741465000
StartTimelong

The start time of the backup task, such as 1554560477000.

1583741439000
BackupSetExpiredTimelong

The point in time when the backup set expires, such as 1554560477000.

1554560477000
StorageMethodstring

The storage class of the backup data. Valid values:

  • Standard: The storage class is Standard.
  • IA: The storage class is Infrequent Access (IA).
  • Archive: The storage class is Archive.
  • UNKNOWN: The storage class is unknown. This value is returned because the task is not complete.
Standard
BackupSetIdstring

The ID of the backup set.

1ibh2f5uXXXX
BackupSizelong

The size of the backup set.

151

Example

Normal return example

JSONFormat

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "636BC118-6080-4119-A6B5-C199CEC1037D",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 10,
  "Items": [
    {
      "FinishTime": 1583741466000,
      "BackupStatus": "finish",
      "SourceEndpointIpPort": "100.X.X.10:33204",
      "CreateTime": 1583740896000,
      "ErrMessage": "NULL",
      "BackupObjects": "[{\\\"DBName\\\":\\\"test\\\"}]",
      "EndTime": 1583741465000,
      "StartTime": 1583741439000,
      "BackupSetExpiredTime": 1554560477000,
      "StorageMethod": "Standard",
      "BackupSetId": "1ibh2f5uXXXX",
      "BackupSize": 151
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.