All Products
Search
Document Center

ApsaraDB RDS:DescribeLogBackupFiles

Last Updated:Mar 22, 2024

Queries the log backup files of an ApsaraDB RDS for SQL Server instance.

Operation description

Supported database engines

SQL Server

Note You can call the DescribeBinlogFiles operation to query the log files of instances that run different database engines.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
rds:DescribeLogBackupFilesREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxx
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.

2018-10-01T08:40Z
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.

2018-10-31T08:40Z
PageSizeintegerNo

The number of entries to return on each page. Valid values: 30 to 1000. Default value: 30.

30
PageNumberintegerNo

The page number. Valid values: any non-zero positive integer.

Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalFileSizelong

The total size of log files. Unit: bytes.

2300
PageNumberinteger

The page number of the page returned.

1
RequestIdstring

The request ID.

F8EC669C-FC85-43D7-AF06-C3641626B37E
PageRecordCountinteger

The number of log files on the current page.

100
TotalRecordCountinteger

The total number of log files.

17
Itemsobject []

The details of log files.

LogBeginTimestring

The start time of the log file. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

2018-10-31T08:40Z
LinkExpiredTimestring

The expiration time of the URL. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2019-03-01T15:04:13Z
LogEndTimestring

The end time of the log file. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

2018-10-31T08:40Z
FileSizelong

The size of the log file. Unit: bytes.

788480

Examples

Sample success responses

JSONformat

{
  "TotalFileSize": 2300,
  "PageNumber": 1,
  "RequestId": "F8EC669C-FC85-43D7-AF06-C3641626B37E",
  "PageRecordCount": 100,
  "TotalRecordCount": 17,
  "Items": {
    "BinLogFile": [
      {
        "LogBeginTime": "2018-10-31T08:40Z",
        "IntranetDownloadLink": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
        "LinkExpiredTime": "2019-03-01T15:04:13Z",
        "DownloadLink": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
        "LogEndTime": "2018-10-31T08:40Z",
        "FileSize": 788480
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400ParameterLeastAssociateMust input at least one optional parameter.The point in time or the data backup file cannot be left unspecified. Specify a point in time or a data backup file and try again.
400InvalidParameters.FormatSpecified parameter is not valid.-
400ParameterAbsenceNecessary parameter is absence.You must pass in the required parameter.
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.The operation failed. The operation is not supported for the database engine that is run on the RDS instance.
403IncorrectDBInstanceCharacterTypeCurrent DB Instance character_type does not support this operation.This operation is not supported for the character type of the current instance.
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.The operation failed. The RDS instance is locked.
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.The RDS instance cannot be found, is deleted, or does not support the operation.

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