Call the DescribeFullBackupList operation to view the DBS full backup task list.

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 Yes DescribeFullBackupList

The operation that you want to perform. Valid values: DescribeFullBackupList.

BackupPlanId String Yes 1ibh2XXXXXXX

The ID of the backup plan.

PageSize Integer Optional 30

The number of records on each page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.

PageNum Integer Optional 1

The number of the page to return. Valid values: any non-zero positive Integer. Default value: 0.

RegionId String No cn-hangzhou

The region ID of the instance. Call DescribeRegions to view the regions supported by DBS.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

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

ShowStorageType Boolean No true

Specifies whether to display the storage type.

Default value: true.

BackupSetId String No 1ibh2XXXXXXX

The ID of the backup set.

Response parameters

Parameter Type Example Description
ErrCode String Param.NotFound

The error code.

ErrMessage String The specified parameter %s value is not valid.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

Items Array of FullBackupFile

The details of full backup tasks.

FullBackupFile
BackupObjects String [{\"DBName\":\"test\"}]

The backup object.

BackupSetExpiredTime Long 1554560477000

The timestamp when the backup set expires. Value: 1554560477000.

BackupSetId String 1ibh2f5uXXXX

The ID of the backup set.

BackupSize Long 151

The size of the backup.

BackupStatus String finish

The status of the backup tasks to query. Valid values:

  • schedule: initializing
  • running: The check task is running.
  • finish
  • stop: Failed
  • pause
CreateTime Long 1583740896000

The start time of the task. Value: 1554560477000.

EndTime Long 1583741465000

The timestamp of the backup end. Value: 1554560477000.

ErrMessage String NULL

The error message.

FinishTime Long 1583741466000

The end timestamp of the task. Value: 1554560477000.

SourceEndpointIpPort String 100.X.X.10:33204

The endpoint used to connect to the database.

StartTime Long 1583741439000

The start time of the backup task. Value: 1554560477000.

StorageMethod String Standard

The storage type. Valid values:

  • Standard
  • IA: IA
  • Archive
  • UNKNOWN: The status of the UNKNOWN task.
PageNum Integer 1

The page number of the page to be returned.

PageSize Integer 10

The number of entries to return on each page.

RequestId String 636BC118-6080-4119-A6B5-C199CEC1037D

The ID of the request.

Success Boolean true

Indicates whether the request succeeded.

TotalElements Integer 1

The total number of full backup tasks.

TotalPages Integer 1

The total number of returned pages.

Examples

Sample requests

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=DescribeFullBackupList
&BackupPlanId=1ibh2XXXXXXX
&<Common request parameters>

Sample success responses

XML format

<DescribeFullBackupListReponse>
  <RequestId>636BC118-6080-4119-A6B5-C199CEC1037D</RequestId>
  <PageSize>30</PageSize>
  <PageNum>0</PageNum>
  <HttpStatusCode>200</HttpStatusCode>
  <TotalElements>1</TotalElements>
  <TotalPages>1</TotalPages>
  <Items>
        <FullBackupFile>
              <SourceEndpointIpPort>100.X.X.10:33204</SourceEndpointIpPort>
              <StorageMethod>Standard</StorageMethod>
              <BackupObjects>[{"DBName":"test_y"}]</BackupObjects>
              <EndTime>1583741465000</EndTime>
              <FinishTime>1583741466000</FinishTime>
              <BackupSize>151</BackupSize>
              <CreateTime>1583740896000</CreateTime>
              <StartTime>1583741439000</StartTime>
              <BackupSetExpiredTime>1646813439000</BackupSetExpiredTime>
              <BackupSetId>1ibh2XXXXXXX</BackupSetId>
              <BackupStatus>finish</BackupStatus>
        </FullBackupFile>
  </Items>
  <Success>true</Success>
</DescribeFullBackupListReponse>

JSON format

{
    "RequestId": "636BC118-6080-4119-A6B5-C199CEC1037D",
    "PageSize": 30,
    "PageNum": 0,
    "HttpStatusCode": 200,
    "TotalElements": 1,
    "TotalPages": 1,
    "Items": {
        "FullBackupFile": [
            {
                "SourceEndpointIpPort": "100.X.X.10:33204",
                "StorageMethod": "Standard",
                "BackupObjects": "[{\"DBName\":\"test_y\"}]",
                "EndTime": 1583741465000,
                "FinishTime": 1583741466000,
                "BackupSize": 151,
                "CreateTime": 1583740896000,
                "StartTime": 1583741439000,
                "BackupSetExpiredTime": 1646813439000,
                "BackupSetId": "1ibh2XXXXXXX",
                "BackupStatus": "finish"
            }
        ]
    },
    "Success": true
}

Error codes

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