All Products
Search

This Product

    PolarDB:DescribeOpenBackupSet

    Document Center

    PolarDB:DescribeOpenBackupSet

    Last Updated:Sep 10, 2026

    Exposes instance topology information and download links for commercial backup sets to support offline restoration of cloud instances.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID of the instance.

    cn-hangzhou
    DBInstanceName

    string

    Yes

    The instance name.

    pxc-********
    RestoreTime

    string

    No

    The point in time to which you want to restore the instance. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

    2024-10-14T00:00:00Z

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    FEA5DC20-6D8A-5979-97AA-FC57546ADC20
    Data

    any

    The struct that contains instance topology information and backup set download links.

    Note

    The canBinlogRecoverToTimeUTC field indicates the point in time to which the backup set can be restored. This point in time is close to the RestoreTime input parameter. Because the latest local binlog of a DN may not have been uploaded, restoration to the desired point in time is not guaranteed.

    {"gmsBackupSet": {"pubFullDownloadUrl": "https://xxxxx","dnName": "pxc-xdb-m-xxxxxx","hostInstanceId": 0001,"binlogs": [],"backupEndTime": "2024-10-21T10:11:56Z","backupLinkExpiredTime": "2024-10-23T06:13:54Z","dnBackupSetId": "00088","notCompletedBinlogs": [],"commitIndex": "15249275","innerFullDownloadUrl": "http://xxxxx","backupStartTime": "2024-10-21T10:09:20Z","backupSetSize": 526118912},"dnBackupSets": [],"insName": "pxc-xxxxx","backupSetId": "cb-xxxxx","canBinlogRecoverToTime": 1729567925000,"backupEndTime": "2024-10-21T10:12:16Z","canBinlogRecoverToTimeUTC": "2024-10-22T03:32:05Z","canBackupMinRecoverToTimeUTC": "2024-10-21T10:11:56Z","pitrInvalid": false,"backupStartTime": "2024-10-21T10:09:16Z","canBackupMinRecoverToTime": 1729505516000}
    Note

    The backup set import tool of PolarDB-X Community Edition uses the struct in the Data field to import backup sets into the structure required for Community Edition restoration.

    Examples

    Success response

    JSON format

    {
  "RequestId": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
  "Data": "{\"gmsBackupSet\": {\"pubFullDownloadUrl\": \"https://xxxxx\",\"dnName\": \"pxc-xdb-m-xxxxxx\",\"hostInstanceId\": 0001,\"binlogs\": [],\"backupEndTime\": \"2024-10-21T10:11:56Z\",\"backupLinkExpiredTime\": \"2024-10-23T06:13:54Z\",\"dnBackupSetId\": \"00088\",\"notCompletedBinlogs\": [],\"commitIndex\": \"15249275\",\"innerFullDownloadUrl\": \"http://xxxxx\",\"backupStartTime\": \"2024-10-21T10:09:20Z\",\"backupSetSize\": 526118912},\"dnBackupSets\": [],\"insName\": \"pxc-xxxxx\",\"backupSetId\": \"cb-xxxxx\",\"canBinlogRecoverToTime\": 1729567925000,\"backupEndTime\": \"2024-10-21T10:12:16Z\",\"canBinlogRecoverToTimeUTC\": \"2024-10-22T03:32:05Z\",\"canBackupMinRecoverToTimeUTC\": \"2024-10-21T10:11:56Z\",\"pitrInvalid\": false,\"backupStartTime\": \"2024-10-21T10:09:16Z\",\"canBackupMinRecoverToTime\": 1729505516000}"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.