DescribeBinlogFiles - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the binary log files of an instance that runs MySQL or MariaDB or the write-ahead logging (WAL) files of an instance that runs PostgreSQL.

Operation description

Supported database engines

MySQL
PostgreSQL
MariaDB

Usage notes

If the return value of the DownloadLink parameter is NULL, ApsaraDB RDS does not provide a download URL.
If the return value of the DownloadLink parameter is not NULL, ApsaraDB RDS provides a URL for you to download backup files. The expiration time of the URL is specified by the LinkExpiredTime parameter. You must download the backup files before the expiration time.
If you use a RAM user to download backup files, you must grant permissions to the RAM user. For more information, see Grant backup file download permissions to a RAM user with read-only permissions.
Each log file that is returned by this operation contains the log entries that are generated over the time range that is specified by the StartTime and EndTime parameters.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribeBinlogFiles	READ	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.	rm-uf6wjk5xxxxxxx
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2011-06-01T15:00:00Z
EndTime	string	Yes	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:mm:ssZ format. The time must be in UTC.	2011-06-20T15:00:00Z
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 to 100. Default value: 30.	30
PageNumber	integer	No	The page number. Valid values: any non-zero positive integer. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalFileSize	long	The total size of the log file.	2269410
PageNumber	integer	The page number.	1
RequestId	string	The request ID.	ED169A3E-1657-4104-82AB-24EA8CD0DB75
PageRecordCount	integer	The number of log files on the current page.	30
TotalRecordCount	integer	The total number of log files.	100
Items	object []	The details of the log file.
RemoteStatus	string	The status of the log file that is stored in the Object Storage Service (OSS) bucket. Valid values: Uploading Completed	Completed
IntranetDownloadLink	string	The URL that is used to download files over an internal network.	http://rdslog-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxxx
LogBeginTime	string	The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-02-09T17:45:21Z
LinkExpiredTime	string	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.	2013-06-09T18:00:00Z
DownloadLink	string	The HTTP-based download URL of the log file. If the return value of this parameter is NULL, ApsaraDB RDS does not provide a download URL for the log file.	http://rdsxxxxx.oss.aliyuncs.com/xxxxxx
LogFileName	string	The log file name.	000000040000000000000019
Checksum	string	The checksum. The value of this parameter is calculated by using the CRC64 algorithm.	18358304393468701857
LogEndTime	string	The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-02-15T13:10:28Z
HostInstanceID	string	The ID of the instance to which the log file belongs. This parameter helps determine whether the log file is generated on the primary instance or the secondary instance. Note You can log on to the ApsaraDB RDS console and go to the instance details page. In the left-side navigation pane, click Service Availability to view the values of Primary Instance No. and Secondary Instance No..	5841973
FileSize	long	The size of the log file. Unit: bytes.	2269410

Examples

Sample success responses

JSONformat

{
  "TotalFileSize": 2269410,
  "PageNumber": 1,
  "RequestId": "ED169A3E-1657-4104-82AB-24EA8CD0DB75",
  "PageRecordCount": 30,
  "TotalRecordCount": 100,
  "Items": {
    "BinLogFile": [
      {
        "RemoteStatus": "Completed",
        "IntranetDownloadLink": "http://rdslog-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxxx",
        "LogBeginTime": "2019-02-09T17:45:21Z",
        "LinkExpiredTime": "2013-06-09T18:00:00Z",
        "DownloadLink": "http://rdsxxxxx.oss.aliyuncs.com/xxxxxx ",
        "LogFileName": "000000040000000000000019",
        "Checksum": "18358304393468701857",
        "LogEndTime": "2019-02-15T13:10:28Z",
        "HostInstanceID": "5841973",
        "FileSize": 2269410
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterLeastAssociate	Must 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.
400	InvalidParameters.Format	Specified parameter is not valid	The operation failed. The values of some parameters are invalid.
400	ParameterAbsence	Necessary parameter is absence.	You must pass in the required parameter.
400	ServiceTemporarilyClosed	Service temporarily closed.	The task is closed.
400	ReadDBInstanceNotSupport	The operation is not permitted due to type of the instance.	-
400	InvalidStartTime.Format	Specified start time is not valid.	The start time is invalid.
400	InvalidEndTime.Format	Specified end time is not valid.	The end time is invalid. Check the end time.
400	InvalidParameterCombination	The end time must be greater than the start time	The end time must be later than the start time.
403	IncorrectDBInstanceEngine	Current 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.
403	IncorrectDBInstanceCharacterType	Current DB Instance character_type does not support this operation.	This operation is not supported for the character type of the current instance.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	-
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The operation failed. The RDS instance is locked.
404	InvalidDBInstance.NotFound	Specified 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.