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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
rds:DescribeCrossRegionLogBackupFiles | READ |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. | rm-uf6wjk5xxxxxxxxxx |
RegionId | string | Yes | 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 |
CrossBackupRegion | string | No | 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 |
StartTime | string | Yes | 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 |
EndTime | string | Yes | The number of entries to return on each page. Valid values:
Default value: 30. | 2019-06-15T12:10:00Z |
PageSize | integer | No | The number of the page to return. Pages start from page 1. Default value: 1. | 30 |
PageNumber | integer | No | 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
Examples
Sample success responses
JSON
format
{"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}
XML
format
<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 code | Error code | Error message | Description |
---|---|---|---|
400 | ParameterAbsence | Necessary param is absence. | - |
400 | InvalidParameters.Format | Specified parameter is not valid. | - |
400 | InvalidRegion.Format | Specified Region is not valid. | The region ID is invalid. Check the region ID. |
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 | InvalidTime.Format | Specified time is not valid. | The time format is invalid. |
403 | CrossBackupNotSupport | Specified region not support cross region backup. | Cross-zone backup is not supported in the specified region. |
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.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2022-09-01 | The error codes of the API operation change. | |||||||||
|