You can call this operation to query backup logs and the URLs for downloading backup logs.

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 No DescribeBackupLogs

The operation that you want to perform. Set the value to DescribeBackupLogs.

DBClusterId String Yes pc-bpxxxxxxx

The ID of the cluster that you want to manage.

EndTime String Yes 2020-02-12T15:00Z

The end time 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.

StartTime String Yes 2020-02-01T15:00Z

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.

PageSize Integer No 30

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

  • 30
  • 50
  • 100

Default value: 30

PageNumber Integer No 1

The number of the page to return. Pages start from page 1.

Default value: 1

Response parameters

Parameter Type Example Description
RequestId String ADAC63DB-0691-4ECE-949A-FAEA686A1402

The ID of the request.

TotalRecordCount String 2

The total number of entries returned.

PageNumber String 1

The page number of the returned page.

PageRecordCount String 2

The number of returned entries on the current page.

Items Array

The details of the backup logs returned.

BackupLogId String 1111111111

The ID of the backup log.

BackupLogName String ib_logfile1

The name of the backup log.

BackupLogStartTime String 2020-02-12T03:54:43Z

The beginning of the queried time range. The time follows the ISO 8601 standard in the YYYY-MM-DD'T'HH:mm:ssZ format. The time is displayed in UTC.

BackupLogEndTime String 2020-02-12T03:55:31Z

The end of the queried time range. The time follows the ISO 8601 standard in the YYYY-MM-DD'T'HH:mm:ssZ format. The time is displayed in UTC.

BackupLogSize String 1073741824

The size of the backup log, in bytes.

DownloadLink String http://xxxxxxxxxxx.oss-cn-hangzhou.aliyuncs.com

The public URL for downloading the backup log.

IntranetDownloadLink String http://xxxxxxxxxxx.oss-cn-hangzhou-internal.aliyuncs.com

The internal URL for downloading the backup log.

LinkExpiredTime String 2020-02-14T08:40:50Z

The time when the URL expires.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeBackupLogs
&DBClusterId=pc-bpxxxxxxx
&EndTime=2020-02-12T15:00Z
&StartTime=2020-02-01T15:00Z
&<Common request parameters>

Sample success responses

XML format

<TotalRecordCount>2</TotalRecordCount>
<PageRecordCount>2</PageRecordCount>
<RequestId>ADAC63DB-0691-4ECE-949A-FAEA686A1402</RequestId>
<PageNumber>1</PageNumber>
<Items>
    <BackupLog>
        <DownloadLink>http://xxxxxxxxxxx.oss-cn-hangzhou.aliyuncs.com</DownloadLink>
        <BackupLogEndTime>2020-02-12T03:55:31Z</BackupLogEndTime>
        <BackupLogId>1111111111</BackupLogId>
        <BackupLogName>ib_logfile1</BackupLogName>
        <LinkExpiredTime>2020-02-14T08:40:50Z</LinkExpiredTime>
        <BackupLogSize>1073741824</BackupLogSize>
        <IntranetDownloadLink>http://xxxxxxxxxxx.oss-cn-hangzhou-internal.aliyuncs.com</IntranetDownloadLink>
        <BackupLogStartTime>2020-02-12T03:54:43Z</BackupLogStartTime>
    </BackupLog>
    <BackupLog>
        <DownloadLink>http://xxxxxxxxxxx.oss-cn-hangzhou.aliyuncs.com</DownloadLink>
        <BackupLogEndTime>2020-02-12T03:54:45Z</BackupLogEndTime>
        <BackupLogId>2222222222</BackupLogId>
        <BackupLogName>ib_logfile2</BackupLogName>
        <LinkExpiredTime>2020-02-14T08:40:50Z</LinkExpiredTime>
        <BackupLogSize>1073741824</BackupLogSize>
        <IntranetDownloadLink>http://xxxxxxxxxxx.oss-cn-hangzhou-internal.aliyuncs.com</IntranetDownloadLink>
        <BackupLogStartTime>2020-02-12T03:53:55Z</BackupLogStartTime>
    </BackupLog>
</Items>

JSON format

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

Error codes

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