All Products
Search
Document Center

ApsaraDB RDS:DescribeCrossRegionLogBackupFiles

Last Updated:May 29, 2023

You can call the DescribeCrossRegionLogBackupFiles operation to query the cross-region log backup files of an ApsaraDB RDS instance.

Operation Description

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

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

rm-uf6wjk5xxxxxxxxxx
RegionIdstringYes

The ID of the destination region where the cross-region backup files of the instance are stored. You can call the DescribeCrossRegionBackupDBInstance operation to query the most recent region list.

cn-hangzhou
CrossBackupRegionstringNo

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.

cn-shanghai
StartTimestringYes

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

2019-05-30T12:10:00Z
EndTimestringYes

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

  • 30
  • 50
  • 100

Default value: 30.

2019-06-15T12:10:00Z
PageSizeintegerNo

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

Default value: 1.

30
PageNumberintegerNo

The end of the time range queried. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

1

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

The beginning of the time range queried. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2019-06-15T12:10:00Z
StartTimestring

The ID of the request.

2019-05-30T12:10:00Z
RequestIdstring

The number of cross-region log backup files on the current page.

DAC241E8-28E6-49DA-BFB0-B2DD090885C1
PageRecordCountinteger

The total number of entries returned.

30
TotalRecordCountinteger

The ID of the instance.

100
DBInstanceIdstring

The page number of the returned page. Pages start from page 1.

Default value: 1.

rm-uf6wjk5xxxxxxxxxx
PageNumberinteger

The region ID of the instance.

1
RegionIdstring

An array that consists of cross-region log backup files.

cn-hangzhou
Itemsobject []

The start time of the cross-region log backup file. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

LogBeginTimestring

The time when the download URL of the cross-region log backup file expires. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2019-05-30T12:10:00Z
LinkExpiredTimestring

The internal URL from which you can download the cross-region log backup file.

2019-06-30T15:00:00Z
LogFileNamestring

The ID of the destination region where the cross-region log backup file is stored.

cn-hangzhou_rm-bpxxxxx_7198739_mysql-bin.000230
CrossBackupRegionstring

The external URL from which you can download the cross-region log backup file.

cn-shanghai
CrossLogBackupSizelong

The ID of the instance.

5312836
InstanceIdinteger

The ID of the cross-region log backup file.

8161055
CrossLogBackupIdinteger

The end time of the cross-region log backup file. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

14567
LogEndTimestring

For more information about how to query the cross-region data backup files of an RDS instance, see DescribeCrossRegionBackups.

Before you call this operation, make sure that the instance runs one of the following database engine versions and RDS editions:

  • MySQL 8.0 on RDS High-availability Edition (with local SSDs)
  • MySQL 5.7 on RDS High-availability Edition (with local SSDs)
  • MySQL 5.6
2019-05-30T20:10:00Z

Examples

Sample success responses

JSONformat

{"Items":{
	"Item":[{
	"LinkExpiredTime":"2019-06-02T07:36:18Z",
	"CrossBackupRegion":"cn-zhangjiakou",
	"LogEndTime":"2019-06-01T06:11:49Z",
	"LogBeginTime":"2019-06-01T00:11:44Z",
	"InstanceId":7198743,
	"CrossLogBackupSize":770014,
	"CrossDownloadLink":"http://rdsddrlog-zb.oss-cn-zhangjiakou.aliyuncs.com/xxxxxx",
	"CrossIntranetDownloadLink":"http://rdsddrlog-zb.oss-cn-zhangjiakou-internal.aliyuncs.com/xxxxx"}
	]},
	"PageNumber":1,
	"TotalRecordCount":52,
	"DBInstanceId":"rm-xxxxx",
	"RegionId":"cn-hangzhou",
	"RequestId":"A9723BCE-F32F-4F05-9922-8371C0842FA7",
	"EndTime":"EndTime=2019-06-15T12:10:00Z",
	"StartTime":"2019-05-30T12:10:00Z",
	"PageRecordCount":10}

XMLformat

<DescribeCrossRegionLogBackupFilesResponse>
<Items>
		<Item>
			<LinkExpiredTime>2019-06-02T07:36:18Z</LinkExpiredTime>
			<CrossBackupRegion>cn-zhangjiakou</CrossBackupRegion>
			<LogEndTime>2019-06-01T06:11:49Z</LogEndTime>
			<LogBeginTime>2019-06-01T00:11:44Z</LogBeginTime>
			<InstanceId>7198743</InstanceId>
			<CrossLogBackupSize>770014</CrossLogBackupSize>
			<CrossDownloadLink>http://rdsddrlog-zb.oss-cn-zhangjiakou.aliyuncs.com/xxxxxx</CrossDownloadLink>
			<CrossIntranetDownloadLink>http://rdsddrlog-zb.oss-cn-zhangjiakou-internal.aliyuncs.com/xxxxx</CrossIntranetDownloadLink>
		</Item>
	</Items>
	<PageNumber>1</PageNumber>
	<TotalRecordCount>52</TotalRecordCount>
	<DBInstanceId>rm-xxxxx</DBInstanceId>
	<RegionId>cn-hangzhou</RegionId>
	<RequestId>A9723BCE-F32F-4F05-9922-8371C0842FA7</RequestId>
	<EndTime>EndTime=2019-06-15T12:10:00Z</EndTime>
	<StartTime>2019-05-30T12:10:00Z</StartTime>
	<PageRecordCount>10</PageRecordCount>
</DescribeCrossRegionLogBackupFilesResponse>

Error codes

HTTP status codeError codeError messageDescription
400ParameterAbsenceNecessary param is absence.-
400InvalidParameters.FormatSpecified parameter is not valid.-
400InvalidRegion.FormatSpecified Region is not valid.The region ID is invalid. Check the region ID.
400InvalidStartTime.FormatSpecified start time is not valid.The start time is invalid.
400InvalidEndTime.FormatSpecified end time is not valid.The end time is invalid. Check the end time.
400InvalidTime.FormatSpecified time is not valid.The time format is invalid.
403CrossBackupNotSupportSpecified region not support cross region backup.Cross-zone backup is not supported in the specified region.
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.

Change history

Change timeSummary of changesOperation
2022-09-01The error codes of the API operation change.
Change itemChange content
Error CodesThe error codes of the API operation change.
    Error Codes 404 change
    delete Error Codes: 400
    delete Error Codes: 403