All Products
Search
Document Center

ApsaraDB RDS:DescribeCrossRegionLogBackupFiles

Last Updated:Feb 29, 2024

Queries the cross-region log backup files of an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.
Note For more information about how to query cross-region data backup files, see DescribeCrossRegionBackups .

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

rm-uf6wjk5xxxxxxxxxx
RegionIdstringYes

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

cn-hangzhou
CrossBackupRegionstringNo

The ID of the destination region within which the cross-region backup file is stored. You can call the DescribeCrossRegionBackupDBInstance operation to query the region ID.

cn-shanghai
StartTimestringYes

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.

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

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-06-15T12:10:00Z
PageSizeintegerNo

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

  • 30
  • 50
  • 100

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.

EndTimestring

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-06-15T12:10:00Z
StartTimestring

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-05-30T12:10:00Z
RequestIdstring

The request ID.

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

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

30
TotalRecordCountinteger

The total number of entries that are returned.

100
DBInstanceIdstring

The instance ID.

rm-uf6wjk5xxxxxxxxxx
PageNumberinteger

The page number. Pages start from page 1.

Default value: 1.

1
RegionIdstring

The region ID of the instance.

cn-hangzhou
Itemsobject []

The cross-region log backup files.

LogBeginTimestring

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.

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

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

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

The name of the cross-region log backup file.

cn-hangzhou_rm-bpxxxxx_7198739_mysql-bin.000230
CrossBackupRegionstring

The ID of the destination region within which the cross-region backup file is stored.

cn-shanghai
CrossLogBackupSizelong

The size of the cross-region log backup file. Unit: bytes.

5312836
InstanceIdinteger

The instance ID.

8161055
CrossLogBackupIdinteger

The ID of the cross-region log backup file.

14567
LogEndTimestring

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.

2019-05-30T20:10:00Z

Examples

Sample success responses

JSONformat

{
  "EndTime": "2019-06-15T12:10:00Z",
  "StartTime": "2019-05-30T12:10:00Z",
  "RequestId": "DAC241E8-28E6-49DA-BFB0-B2DD090885C1",
  "PageRecordCount": 30,
  "TotalRecordCount": 100,
  "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
  "PageNumber": 1,
  "RegionId": "cn-hangzhou",
  "Items": {
    "Item": [
      {
        "LogBeginTime": "2019-05-30T12:10:00Z",
        "LinkExpiredTime": "2019-06-30T15:00:00Z",
        "CrossIntranetDownloadLink": "http://rdsddrlog-zb.oss-cn-zhangjiakou-internal.aliyuncs.com/xxxxx",
        "LogFileName": "cn-hangzhou_rm-bpxxxxx_7198739_mysql-bin.000230",
        "CrossBackupRegion": "cn-shanghai",
        "CrossDownloadLink": "http://rdsddrlog-zb.oss-cn-zhangjiakou.aliyuncs.com/xxxxx",
        "CrossLogBackupSize": 5312836,
        "InstanceId": 8161055,
        "CrossLogBackupId": 14567,
        "LogEndTime": "2019-05-30T20:10:00Z"
      }
    ]
  }
}

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.
404InvalidPage.notFoundPage not found.The specified parameters are not found. Check your parameters.

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

Change history

Change timeSummary of changesOperation
2022-09-01The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 404 change
    delete Error Codes: 400
    delete Error Codes: 403