DescribeBackupLogs - PolarDB

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	DescribeBackupLogs	The operation that you want to perform. Set the value to DescribeBackupLogs.
DBClusterId	String	Yes	pc-**************	The ID of the cluster.
StartTime	String	Yes	2020-02-01T15:00Z	The beginning of the time range. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.
EndTime	String	Yes	2020-02-12T15:00Z	The end of the time ranged. The end time must be later than the start time. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.
BackupRegion	String	No	cn-hangzhou	The region for the backup data.
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. The value must be an integer that is larger than 0. Default value: 1.

Response parameters


Parameter	Type	Example	Description
TotalRecordCount	String	2	The total number of entries.
PageRecordCount	String	2	The number of entries returned per page.
RequestId	String	ADAC63DB-0691-4ECE-949A-FAEA68******	The ID of the request.
PageNumber	String	1	The number of the returned page.
Items	Array of BackupLog		Details about backup logs.
BackupLog
BackupLogId	String	1111111111	The ID of the backup log.
IntranetDownloadLink	String	http://***********.oss-cn-hangzhou-internal.aliyuncs.com	The internal URL to download the backup log.
LinkExpiredTime	String	2020-02-14T08:40:50Z	The time when the download URL expires.
BackupLogStartTime	String	2020-02-12T03:54:43Z	The time when the backup task started. The time is in the `YYYY-MM-DD'T'HH:mm:ssZ` format. The time is displayed in UTC.
BackupLogEndTime	String	2020-02-12T03:55:31Z	The time when the backup log ended. The time is in the `YYYY-MM-DD'T'HH:mm:ssZ` format. The time is displayed in UTC.
DownloadLink	String	http://***********.oss-cn-hangzhou.aliyuncs.com	The public URL to download the backup log.
BackupLogSize	String	1073741824	The size of the backup log. Unit: bytes.
BackupLogName	String	ib_logfile1	The name of the backup log.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeBackupLogs
&DBClusterId=pc-**************
&StartTime=2020-02-01T15:00Z
&EndTime=2020-02-12T15:00Z
&BackupRegion=cn-hangzhou
&PageSize=30
&PageNumber=1
&<Common request parameters>

Sample success response

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupLogsResponse>
<TotalRecordCount>2</TotalRecordCount>
<PageRecordCount>2</PageRecordCount>
<RequestId>ADAC63DB-0691-4ECE-949A-FAEA68******</RequestId>
<PageNumber>1</PageNumber>
<Items>
    <BackupLog>
        <DownloadLink>http://***********.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://***********.oss-cn-hangzhou-internal.aliyuncs.com</IntranetDownloadLink>
        <BackupLogStartTime>2020-02-12T03:54:43Z</BackupLogStartTime>
    </BackupLog>
</Items>
</DescribeBackupLogsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 2,
  "PageRecordCount" : 2,
  "RequestId" : "ADAC63DB-0691-4ECE-949A-FAEA68******",
  "PageNumber" : 1,
  "Items" : {
    "BackupLog" : [ {
      "DownloadLink" : "http://***********.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://***********.oss-cn-hangzhou-internal.aliyuncs.com",
      "BackupLogStartTime" : "2020-02-12T03:54:43Z"
    } ]
  }
}

Error codes


HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	The error message returned because the specified StartTime parameter is invalid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	The error message returned because the specified EndTime parameter is invalid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The error message returned because the specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The error message returned because the specified PageNumber parameter is invalid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The error message returned because the specified DBClusterId does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The error message returned because the specified DBClusterId parameter is invalid.

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