All Products
Search

This Product

    PolarDB:DescribeBinaryLogList

    Document Center

    PolarDB:DescribeBinaryLogList

    Last Updated:Sep 10, 2026

    Queries binary logs by calling the DescribeBinaryLogList operation.

    Operation description

    • Binary log files are retained for 15 days by default.

    • The returned log list includes all logs log record end time is after the query start time and log record start time is before the query end time.

    • When DownloadLink is not NULL, you can download the backup file from this URL. The URL is valid for 2 days after it is generated. Download the file before the URL expires.

    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

    polardbx:DescribeBinaryLogList

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID of the instance.

    cn-hangzhou
    PageNumber

    integer

    No

    The page number of the current binary log list. Default value: 1.

    1
    PageSize

    integer

    No

    The number of binary logs to return on each page. Default value: 30.

    30
    DBInstanceName

    string

    Yes

    The name of the instance.

    pxc-hz1fds
    StartTime

    string

    Yes

    The start time of the query for the binary log list.

    2021-09-09 10:27:46
    EndTime

    string

    Yes

    The end time of the query for the binary log list.

    2021-11-09 10:27:46
    InstanceName

    string

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9
    PageNumber

    integer

    The page number of the current query.

    1
    PageSize

    integer

    The number of binary logs displayed on the current page.

    30
    TotalNumber

    integer

    The total number of binary log files returned.

    100
    LogList

    array<object>

    The list of binary log files.

    object

    EndTime

    string

    The end time of the current binary log.

    2021-11-09 10:27:46
    ModifiedTime

    string

    The last modified time.

    2021-11-09 10:27:46
    UploadHost

    string

    The backup host.

    10.110.88.9
    UploadStatus

    integer

    The backup status. Valid values:

    • 0: not backed up.

    • 1: being backed up.

    • 2: backed up.

    2
    BeginTime

    string

    The start time of the log.

    2021-09-09 10:27:46
    LogSize

    integer

    The size of the current log file.

    536870912
    FileName

    string

    The name of the binary log file.

    binlog.000001
    CreatedTime

    string

    The creation time of the file.

    2021-09-09 10:27:46
    PurgeStatus

    integer

    The purge status. Valid values:

    • 0: not deleted.

    • 1: deleted.

    0
    Id

    integer

    The unique ID of the current record.

    100

    Examples

    Success response

    JSON format

    {
  "RequestId": "2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalNumber": 100,
  "LogList": [
    {
      "EndTime": "2021-11-09 10:27:46",
      "ModifiedTime": "2021-11-09 10:27:46",
      "UploadHost": "10.110.88.9",
      "UploadStatus": 2,
      "DownloadLink": "http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd132143sfds1/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12dsafddsf&Signature=fdpm%bdsfadsa%2F%bdsafdsaf%3D",
      "BeginTime": "2021-09-09 10:27:46",
      "LogSize": 536870912,
      "FileName": "binlog.000001",
      "CreatedTime": "2021-09-09 10:27:46",
      "PurgeStatus": 0,
      "Id": 100
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.