All Products
Search
Document Center

PolarDB:DescribeMetaList

Last Updated:Mar 01, 2024

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

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
polardb:DescribeMetaListREAD
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query the details of all clusters under your account.
pc-**************
BackupIdstringNo

The ID of the data backup file.

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.
  • 111111
    RestoreTimestringNo

    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.
    2020-10-04T01:40:00Z
    GetDbNamestringNo

    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.
  • test_db
    PageSizeintegerNo

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

    • 30

    • 50

    • 100

      Default value: 30.

    30
    PageNumberintegerNo

    The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

    1
    RegionCodestringNo

    The ID of the region in which the instance resides. You can call the DescribeDBClusterAttribute operation to query the region ID of the instance.

    cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object
    TotalPageCountstring

    The total number of returned pages.

    1
    TotalRecordCountstring

    The total number of entries.

    2
    PageSizestring

    The number of entries returned per page.

    30
    RequestIdstring

    The ID of the request.

    AA815DE7-B576-4B22-B33C-3FB31A******
    PageNumberstring

    The number of the returned page.

    1
    Itemsobject []

    The details of databases and tables that can be restored.

    Databasestring

    The name of the database that can be restored.

    test_db
    Tablesarray

    The name of the table that can be restored.

    string

    The table name.

    test_tb1
    DBClusterIdstring

    The ID of the cluster.

    pc-bp1s826a1up******

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidRestoreType.FormatSpecified restore type is not valid.The specified restore type is invalid.
    400InvalidRestoreTime.FormatSpecified restore time is not valid.The specified restoration time is invalid.
    400InvalidBackupSetID.NotFoundSpecified backup set ID does not exist.The specified backup set ID does not exist.
    400IncorrectBackupSetStateCurrent backup set state does not support operations.This operation is not supported while the backup set is in the current state.
    400InvalidDBName.DuplicateSpecified DB name already exists in the This instance.The specified DBName parameter already exists in the cluster.
    400InvalidParameters.FormatSpecified parameters is not valid.The specified parameters are invalid.
    400InsufficientResourceCapacityThere is insufficient capacity available for the requested instance.Insufficient storage capacity for the specified cluster.
    400InvalidRestoreType.NotFoundAt least one of BackupId and RestoreTime is malformed.The format of the specified BackupId or RestoreTime parameter is invalid.
    400MissingUserIDThe request is missing a user_id parameter.You must specify the UserID parameter in the request.
    400MissingUIDThe request is missing a uid parameter.You must specify the UID parameter in the request.
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404InvalidBackup.NotFoundThe available backup does not exist in recovery time.The specified backup does not exist within the time range for restoration.
    404InvalidDBClusterId.NotFoundThe DBInstanceId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

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

    Change history

    Change timeSummary of changesOperation
    2023-09-18The 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: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: RegionCode
    2023-09-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 404 change
      delete Error Codes: 400
    2022-12-15The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
    2021-10-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404