All Products
Search
Document Center

ApsaraDB RDS:DescribeCrossBackupMetaList

Last Updated:May 11, 2024

Queries the databases and tables whose data is included in a cross-region backup file of an instance.

Operation description

ApsaraDB RDS for MySQL instances support cross-region backup and restoration. For more information, see Back up an ApsaraDB RDS for MySQL instance across regions and Restore the data of an ApsaraDB RDS for MySQL instance across regions.

Before you call this operation, make sure that the instance runs one of the following 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:DescribeCrossBackupMetaListREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackupSetIdstringYes

The ID of the cross-region backup file that you want to use. You can call the DescribeCrossRegionBackups operation to query the ID of the cross-region backup file.

123456
GetDbNamestringNo

The name of the database that you want to query. The system implements exact match based on the value of this parameter and returns the name of the matched database and the names of the tables in the matched database.

testdb1
PatternstringNo

The name of the database that you want to query. The system implements fuzzy match based on the value of this parameter and returns only the name of the matched database.

Note You can implement fuzzy match and then exact match. For example, you can set the Pattern parameter to test to query the testdb1 and testdb2 databases. Then, you can specify the GetDbName parameter to query only the matched database and the tables in the matched database.
test
PageSizestringNo

The number of entries to return per page. Default value: 1.

Note This parameter only takes effect when you specify the PageIndex parameter.
30
PageIndexstringNo

The number of the page to return. Valid values: any non-zero positive integer.

Note This parameter only takes effect when you specify the PageSize parameter.
1
RegionstringNo

The region ID of the instance.

cn-hangzhou
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object
DBInstanceNamestring

The instance to which the cross-region backup file belongs.

rm-uf6wjk5xxxxxxx
TotalPageCountinteger

The total number of pages returned.

1
RequestIdstring

The ID of the request.

60F9A12A-16B8-4728-B099-4CA38D32C31C
PageRecordCountinteger

The number of entries returned per page.

1
TotalRecordCountinteger

The total number of returned entries.

1
PageNumberinteger

The page number of the returned page.

1
Itemsobject []

An array that consists of the information about the databases and tables whose data is included in the cross-region backup file.

Tablesstring

An array that consists of the names of the tables that the database contains. If the database contains more than one table, the names of these tables are separated by commas (,).

test1,test2
Databasestring

The name of the database.

testdb1
Sizestring

The size of the table. Unit: KB. If the database contains more than one table, the names of these tables are separated by commas (,).

1000

Examples

Sample success responses

JSONformat

{
  "DBInstanceName": "rm-uf6wjk5xxxxxxx",
  "TotalPageCount": 1,
  "RequestId": "60F9A12A-16B8-4728-B099-4CA38D32C31C",
  "PageRecordCount": 1,
  "TotalRecordCount": 1,
  "PageNumber": 1,
  "Items": {
    "Meta": [
      {
        "Tables": "test1,test2",
        "Database": "testdb1",
        "Size": "1000"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NoAvailableDisasterRestoreBaksetNo available disaster restore bakset-
400InvalidPageSizeThe page size is invalidThe value of the pageSize parameter is invalid. The value of this parameter must be a number.
400InvalidPageIndexThe page index is invalid-
400InvalidRestoreTime.FormatSpecified restore time is not valid.The operation failed. The point in time is invalid. Specify a valid point in time.
403InvalidMeta.EmptyMeta information is empty.You must specify the metadata.
403InvalidMeta.TooLargeMeta information is too large.-
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
403IncorrectEngineVersionCurrent engine version does not support operations.The operation failed. The operation is not supported for the version of the database engine that is run on the RDS instance.
403InvalidBackupLogStatusCurrent backup log enable status does not support this operation.The operation failed. Log backups are not enabled, and therefore data cannot be restored to a specified point in time.
404InvalidBackupSetID.NotFoundSpecified backup set ID does not exist.The backup set does not exist. Specify an available backup set.
404InvalidParameters.FormatSpecified parameter({}) is not valid.-
404Request.NotFoundThe requested resource is not available.The requested resources are unavailable.

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

Change history

Change timeSummary of changesOperation
2022-08-04The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId