All Products
Search
Document Center

PolarDB:DescribeBackupLogs

Last Updated:Nov 07, 2023

Queries backup logs and the URLs to download the backup logs.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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
polardb:DescribeBackupLogsWRITE
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

pc-**************
StartTimestringYes

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2020-02-01T15:00Z
EndTimestringYes

The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2020-02-12T15:00Z
BackupRegionstringNo

The region for the backup data.

cn-hangzhou
PageSizeintegerNo

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

  • 30
  • 50
  • 100

Default value: 30.

30
PageNumberintegerNo

The page number of the page to return. The value must be an integer that is larger than 0. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
TotalRecordCountstring

The total number of returned entries.

2
PageRecordCountstring

The number of entries returned per page.

2
RequestIdstring

The request ID.

ADAC63DB-0691-4ECE-949A-FAEA68******
PageNumberstring

The page number of the returned page.

1
Itemsobject []

The details of the backup logs.

BackupLogIdstring

The ID of the backup log.

1111111111
LinkExpiredTimestring

The time when the download URL expires.

2020-02-14T08:40:50Z
BackupLogStartTimestring

The time when the backup task started. The time follows the ISO 8601 standard in the YYYY-MM-DD'T'HH:mm:ssZ format. The time is displayed in UTC.

2020-02-12T03:54:43Z
BackupLogEndTimestring

The time when the backup task ended. The time follows the ISO 8601 standard in the YYYY-MM-DD'T'HH:mm:ssZ format. The time is displayed in UTC.

2020-02-12T03:55:31Z
BackupLogSizestring

The size of the backup log. Unit: bytes.

1073741824
BackupLogNamestring

The name of the backup log.

ib_logfile1

Examples

Sample success responses

JSONformat

{
  "TotalRecordCount": "2",
  "PageRecordCount": "2",
  "RequestId": "ADAC63DB-0691-4ECE-949A-FAEA68******",
  "PageNumber": "1",
  "Items": {
    "BackupLog": [
      {
        "BackupLogId": "1111111111",
        "IntranetDownloadLink": "http://***********.oss-cn-hangzhou-internal.aliyuncs.com",
        "LinkExpiredTime": "2020-02-14T08:40:50Z",
        "BackupLogStartTime": "2020-02-12T03:54:43Z",
        "BackupLogEndTime": "2020-02-12T03:55:31Z",
        "DownloadLink": "http://***********.oss-cn-hangzhou.aliyuncs.com",
        "BackupLogSize": "1073741824",
        "BackupLogName": "ib_logfile1"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedThe specified parameter StartTime is not valid.The specified StartTime parameter is invalid.
400InvalidEndTime.MalformedThe specified parameter EndTime is not valid.The specified EndTime parameter is invalid.
400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.The specified PageSize parameter is invalid.
400InvalidPageNumber.MalformedThe specified parameter PageNumber is not valid.The specified PageNumber parameter is invalid.
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.

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

Change history

Change timeSummary of changesOperation
2023-09-12The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 404 change
    delete Error Codes: 400
2022-06-07The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 404
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: BackupRegion