tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for MariaDB
    Documentation
    Download PDF

    DescribeBackupFiles

    Last updated: 2024-11-20 12:15:22
    Download PDF

      1. API Description

      Domain name for API request: mariadb.intl.tencentcloudapi.com.

      This API is used to query the list of backup files.

      A maximum of 20 requests can be initiated per second for this API.

      We recommend you to use API Explorer
      Try it
      API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

      2. Input Parameters

      The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

      Parameter Name Required Type Description
      Action Yes String Common Params. The value used for this API: DescribeBackupFiles.
      Version Yes String Common Params. The value used for this API: 2017-03-12.
      Region Yes String Common Params. For more information, please see the list of regions supported by the product.
      InstanceId No String Query by instance ID
      BackupType No String Backup type. Valid values: Data (data backup), Binlog (Binlog backup), Errlog (error log), Slowlog (slow log).
      StartTime No String Query by start time
      EndTime No String Query by end time
      Limit No Integer Pagination parameter
      Offset No Integer Pagination parameter
      OrderBy No String Sorting dimension. Valid values: Time, Size.
      OrderType No String Sorting order. Valid values: DESC, ASC.

      3. Output Parameters

      Parameter Name Type Description
      Files Array of InstanceBackupFileItem List of backup files
      TotalCount Integer Total number
      RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

      4. Example

      Example1 None

      Input Example

      POST / HTTP/1.1
Host: mariadb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupFiles
<Common request parameters>

{}

      Output Example

      {
    "Response": {
        "Files": [
            {
                "BackupType": "Data",
                "EndTime": "2022-05-20 00:02:19",
                "FileName": "cos_xtrabackup+1652976129+20220520+000209+3085636221+xbstream.lz4",
                "FilePath": "cos_backup/tdsql/set_1652843814_8559529/xtrabackup/2022-05-20/cos_xtrabackup+1652976129+20220520+000209+3085636221+xbstream.lz4",
                "FileSize": 48721218,
                "InstanceId": "tdsql-lyzax5rb",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "",
                "StartTime": "2022-05-20 00:02:09"
            },
            {
                "BackupType": "Data",
                "EndTime": "2022-05-19 00:23:03",
                "FileName": "cos_xtrabackup+1652890972+20220519+002252+3085636221+xbstream.lz4",
                "FilePath": "cos_backup/tdsql/set_1652843814_8559529/xtrabackup/2022-05-19/cos_xtrabackup+1652890972+20220519+002252+3085636221+xbstream.lz4",
                "FileSize": 47738611,
                "InstanceId": "tdsql-lyzax5rb",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "",
                "StartTime": "2022-05-19 00:22:52"
            },
            {
                "BackupType": "Data",
                "EndTime": "2022-05-18 11:44:52",
                "FileName": "cos_xtrabackup+1652845485+20220518+114445+3085636221+xbstream.lz4",
                "FilePath": "cos_backup/tdsql/set_1652843814_8559529/xtrabackup/2022-05-18/cos_xtrabackup+1652845485+20220518+114445+3085636221+xbstream.lz4",
                "FileSize": 10281128,
                "InstanceId": "tdsql-lyzax5rb",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "",
                "StartTime": "2022-05-18 11:44:45"
            },
            {
                "BackupType": "Binlog",
                "EndTime": "2022-05-20 17:13:31",
                "FileName": "binlog+1652843821+20220518+111701+3085636221+binlog.000002.lz4",
                "FilePath": "cos_backup/tdsql/set_1652843814_8559529/binlog/2022-05-18/binlog+1652843821+20220518+111701+3085636221+binlog.000002.lz4",
                "FileSize": 51119079,
                "InstanceId": "tdsql-lyzax5rb",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "",
                "StartTime": "2022-05-18 11:17:01"
            }
        ],
        "RequestId": "dce77e5f-57b9-4df5-9889-1a4b9f318659",
        "TotalCount": 4
    }
}

      5. Developer Resources

      SDK

      TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

      Command Line Interface

      6. Error Code

      The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

      Error Code Description
      InvalidParameter.ActionNotFound API not found
      UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy