DescribeBackupFiles

Last updated: 2021-10-13 10:36:31

1. API Description

Domain name for API request: sqlserver.tencentcloudapi.com.

This API is used to query the list of unarchived database 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 parameter. The value used for this API: DescribeBackupFiles.
Version Yes String Common parameter. The value used for this API: 2018-03-28.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID in the format of mssql-njj2mtpl
GroupId Yes String Group ID of unarchived backup files, which can be obtained by the DescribeBackups API
Limit No Integer Number of entries to be returned per page. Value range: 1-100. Default value: 20
Offset No Integer Page number. Default value: 0
DatabaseName No String Filter backups by database name. If the parameter is left empty, this filter criterion will not take effect.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of backups
BackupFiles Array of BackupFile List of backup file details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying backup files

Input Example

https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupFiles
&Limit=20
&Offset=0
&InstanceId=mssql-mz23h8n7
&GroupId=241259
&<Common request parameters>

Output Example

{
  "Response": {
    "BackupFiles": [
      {
        "DBs": [
          "db1"
        ],
        "DownloadLink": "https://sqlserver-bucket-sg-1258415541.cos.ap-singapore.myqcloud.com/1251966477%2fsqlserver%2fmssql-mz23h8n7%2fbackup%2fmanual_specific_58002_db1_2021_09_14144312.bak?sign=q-sign-algorithm%3dsha1%26q-ak%3dAKIDrRloa5Zdk580Xo9dCWaNE3kU3MQElsiV%26q-sign-time%3d1631605556%3b1631606456%26q-key-time%3d1631605556%3b1631606456%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3de5e61bfbccf44f6c3dd8a710296108dc95ba16db",
        "FileName": "manual_specific_58002_db1_2021_09_14144312.bak",
        "Id": 36074,
        "Size": 184
      },
      {
        "DBs": [
          "db2"
        ],
        "DownloadLink": "https://sqlserver-bucket-sg-1258415541.cos.ap-singapore.myqcloud.com/1251966477%2fsqlserver%2fmssql-mz23h8n7%2fbackup%2fmanual_specific_58002_db2_2021_09_14144312.bak?sign=q-sign-algorithm%3dsha1%26q-ak%3dAKIDrRloa5Zdk580Xo9dCWaNE3kU3MQElsiV%26q-sign-time%3d1631605556%3b1631606456%26q-key-time%3d1631605556%3b1631606456%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3df977b8f1afee59225e41a9e766b035953ef9527c",
        "FileName": "manual_specific_58002_db2_2021_09_14144312.bak",
        "Id": 36075,
        "Size": 184
      }
    ],
    "RequestId": "cb2fb9fa-152f-11ec-ac75-525400542aa6",
    "TotalCount": 2
  }
}

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
InternalError Internal error.
InternalError.CosError COS API error.
InternalError.DBError Database error
InternalError.GcsError GCS API error.
InternalError.SystemError System error.
InternalError.UnknownError Unknown error.
InvalidParameter Invalid parameter.
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
ResourceNotFound.InstanceNotFound The instance does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication error.