Queries the details of the databases or tables that can be restored.

Note Only PolarDB for MySQL 5.6 clusters support the database and table restoration feature. For more information, see Restore databases and tables.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeMetaList

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

DBClusterId String Yes pc-**************

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query the details of all clusters under your account.
RegionId String No cn-hangzhou

The ID of the region.

Note You can call the DescribeRegions operation to query the region details.
BackupId String No 111111

The ID of the backup set.

Note
  • When you run a query, you must specify the BackId or RestoreTime parameter.
  • You can call the DescribeBackups operation to query the ID of the backup set.
RestoreTime String No 2020-10-04T01:40:00Z

The point in time for the restoration. Specify the time in the YYYY-MM-DDThh:mmZ format. The time must be in UTC.

Note When you run a query, you must specify the BackId or RestoreTime parameter. You can call the DescribeBackups operation to query the point in time for the restoration.
GetDbName String No test_db

Specify the specific database name (such as test_db) to query the names of all data tables that can be restored in the desired database.

Note
  • You can specify only one database name each time.
  • If you do not specify this parameter, you can query the names of all databases that can be restored in the current backup set. However, you cannot query the names of data tables in each database.
PageSize Integer No 30

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

  • 30
  • 50
  • 100

    Default value: 30

PageNumber Integer No 1

The number of the page to return. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.

Response parameters

Parameter Type Example Description
Items Array of MetaItem

The details of databases and tables that can be restored.

Database String test_db

The name of the database that can be restored.

Tables List test_tb1

The name of the table that can be restored.

PageNumber String 1

The number of the returned page.

PageSize String 30

The number of entries returned per page.

RequestId String AA815DE7-B576-4B22-B33C-3FB31A******

The ID of the request.

TotalPageCount String 1

The total number of pages.

TotalRecordCount String 2

The total number of entries.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/? Action=DescribeMetaList
&DBClusterId=pc-**************
&<Common request parameters>

Sample success responses

XML format

<DescribeMetaListResponse>
  <TotalRecordCount>2</TotalRecordCount>
  <TotalPageCount>1</TotalPageCount>
  <RequestId>AA815DE7-B576-4B22-B33C-3FB31A******</RequestId>
  <PageSize>30</PageSize>
  <PageNumber>1</PageNumber>
  <Items>
        <Database>test_db</Database>
        <Tables>test_tb1</Tables>
        <Tables>test_tb2</Tables>
  </Items>
</DescribeMetaListResponse>

JSON format

{
    "TotalRecordCount": 2,
    "TotalPageCount": 1,
    "RequestId": "AA815DE7-B576-4B22-B33C-3FB31A******",
    "PageSize": 30,
    "PageNumber": 1,
    "Items": [
        {
            "Database": "test_db",
            "Tables": [
                "test_tb1",
                "test_tb2"
            ]
        }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.