All Products
Search

This Product

    PolarDB:DescribeBackupLogs

    Document Center

    PolarDB:DescribeBackupLogs

    Last Updated:Dec 11, 2025

    Queries a list of backup logs and returns their download URLs.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:DescribeBackupLogs

    get

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    pc-**************
    StartTime

    string

    Yes

    The beginning of the time range to query. The time is in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

    2020-02-01T15:00Z
    EndTime

    string

    Yes

    The end of the time range to query. The end time must be later than the start time. The time is in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

    2020-02-12T15:00Z
    BackupRegion

    string

    No

    The backup region.

    cn-hangzhou
    PageSize

    integer

    No

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

    • 30

    • 50

    • 100

    The default value is 30.

    30
    PageNumber

    integer

    No

    The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. The default value is 1.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalRecordCount

    string

    The total number of entries.

    2
    PageRecordCount

    string

    The number of entries returned on the current page.

    2
    RequestId

    string

    The request ID.

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

    string

    The page number.

    1
    Items

    object

    BackupLog

    array<object>

    The details of the backup logs.

    object

    BackupLogId

    string

    The backup log ID.

    1111111111
    LinkExpiredTime

    string

    The expiration time of the download URL.

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

    string

    The start time of the backup log. The time is in the YYYY-MM-DD'T'HH:mm:ssZ format. The time is displayed in UTC.

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

    string

    The end time of the backup log. The time is in the YYYY-MM-DD'T'HH:mm:ssZ format. The time is displayed in UTC.

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

    string

    The size of the backup log file, in bytes.

    1073741824
    BackupLogName

    string

    The name of the backup log file.

    ib_logfile1

    Examples

    Success response

    JSON format

    {
  "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 code

    Error code

    Error message

    Description
    400 InvalidStartTime.Malformed The specified parameter StartTime is not valid. The specified StartTime parameter is invalid.
    400 InvalidEndTime.Malformed The specified parameter EndTime is not valid. The specified EndTime parameter is invalid.
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid. The specified PageSize parameter is invalid.
    400 InvalidPageNumber.Malformed The specified parameter PageNumber is not valid. The specified PageNumber parameter is invalid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The specified DBClusterId parameter is invalid.
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.