tencent cloud

All product documents
TencentDB for SQL Server
DocumentationTencentDB for SQL ServerAPI DocumentationBackup APIsDescribeBackupFiles
DescribeBackupFiles
Download PDF
Last updated: 2024-11-26 16:32:31
DescribeBackupFiles
Last updated: 2024-11-26 16:32:31
Download PDF

1. API Description

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

This API is used to query the details of an unarchived backup.

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: 2018-03-28.
Region Yes String Common Params. 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 (Querying archived backup record is not supported).
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.
OrderBy No String List items sorting by backup size. Valid values: desc(descending order), asc (ascending order). Default value: desc.

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, 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 u200cQuerying the details of an unarchived backup.

u200cThis example shows you how to query the details of an unarchived backup.

Input Example

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

Output Example

{
    "Response": {
        "BackupFiles": [
            {
                "CrossBackupAddr": [
                    {
                        "CrossExternalAddr": "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%3d****************%26q-sign-time%3d1631605556%3b1631606456%26q-key-time%3d1631605556%3b1631606456%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3df977b8f1afee59225e41a9e766b035953ef9527c",
                        "CrossInternalAddr": "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%3d****************%26q-sign-time%3d1631605556%3b1631606456%26q-key-time%3d1631605556%3b1631606456%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3df977b8f1afee59225e41a9e766b035953ef9527c",
                        "CrossRegion": "ap-singapore"
                    }
                ],
                "Region": "ap-singapore",
                "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%3d****************%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
            }
        ],
        "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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

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
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon