tencent cloud

DescribeBackupByFlowId
最后更新时间：2025-10-28 22:49:37
DescribeBackupByFlowId
最后更新时间： 2025-10-28 22:49:37

1. API Description

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

This API is used to query the created backup details through the backup creation process ID. The process ID can be obtained through the CreateBackup API.

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: DescribeBackupByFlowId.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId Yes String Instance ID, in the format of mssql-3l3fgqn7.
FlowId Yes String Backup creation process ID, which can be obtained through the CreateBackup API.

3. Output Parameters

Parameter Name Type Description
Id Integer Unique identifier of the backup file. This field is used by the RestoreInstance API. For a single-database backup file, only the unique identifier of the backup file for the first record is returned. Through the DescribeBackupFiles API, IDs of all backup files that are available for rollback can be obtained for single-database backup files.
FileName String File name. For a single-database backup file, only the file name of the first record is returned. Through the DescribeBackupFiles API, file names of all records can be obtained for single-database backup files.
BackupName String Backup task name, which can be customized.
StartTime Timestamp Backup start time.
EndTime Timestamp Backup end time.
Size Integer File size, in KB. For a single-database backup file, only the file size of the first record is returned. Through the DescribeBackupFiles API, file sizes of all records can be obtained for single-database backup files.
Strategy Integer Backup policy: 0 - instance backup; 1 - multi-database backup. When the instance status is 0 - creating, the default value of this field is 0, which has no practical significance.
Status Integer Backup file status. 0 - creating; 1 - successful; 2-failed.
BackupWay Integer Backup method. 0 - scheduled backup; 1 - manual temporary backup. When the instance status is 0 - creating, the default value of this field is 0, which has no practical significance.
DBs Array of String Database list. For a single-database backup file, only the database name included in the first record is returned. Through the DescribeBackupFiles API, the database names of all records can be obtained for single-database backup files.
InternalAddr String Private network download address. For a single-database backup file, only the private network download address of the first record is returned. Through the DescribeBackupFiles API, download addresses of all records can be obtained for single-database backup files.
ExternalAddr String Public network download address. For a single-database backup file, only the public network download address of the first record is returned. Through the DescribeBackupFiles API, download addresses of all records can be obtained for single-database backup files.
GroupId String Aggregation ID. This value is not returned for packaging backup files. Call the DescribeBackupFiles API with this value to obtain detailed information about single-database backup files.
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 Querying Backup Details by Flow ID (Backup Creation in Progress)

This example shows you how to query backup details by flow ID (backup creation in progress) by this API.

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeBackupByFlowId
&InstanceId=mssql-6upluvd5
&FlowId=1000796
&<Common request parameters>

Output Example

{
    "Response": {
        "BackupName": "mssql-6upluvd5_202007311206",
        "BackupWay": 0,
        "DBs": [
            "db1",
            "db2"
        ],
        "EndTime": "0000-00-00 00:00:00",
        "ExternalAddr": "",
        "FileName": "",
        "Id": 0,
        "InternalAddr": "",
        "RequestId": "de6cf7f3-ff88-4baf-a933-4714df850efa",
        "Size": 0,
        "StartTime": "2020-07-31 14:27:33",
        "Status": 0,
        "Strategy": 0,
        "GroupId": "558800"
    }
}

Example2 Querying Backup Details by Flow ID (Backup Completed)

This example shows you how to query backup details by flow ID (backup completed) by this API.

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeBackupByFlowId
&InstanceId=mssql-6upluvd5
&FlowId=1000797
&<Common request parameters>

Output Example

{
    "Response": {
        "BackupName": "mssql-6upluvd5_202007311206",
        "BackupWay": 0,
        "DBs": [
            "db1",
            "db2"
        ],
        "EndTime": "2020-07-31 15:10:27",
        "ExternalAddr": "https://cosback-appid.cos.ap-guangzhou.myqcloud.com/appid%2fsqlserver%2fmssql-mgq355n0%2fbackup%2fautoed_instance_58037_20200728011545.bak.tar?sign=q-sign-algorithm%3dsha1%26q-ak%3d*************************%26q-sign-time%3d1596176966%3b1596177266%26q-key-time%3d1596176966%3b1596177266%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3d3ea8139b631fa13d54b2c03313cbf3850d1e0c2c",
        "FileName": "autoed_instance_58037_20200728011545.bak.tar",
        "Id": 1234568,
        "InternalAddr": "https://cosback-appid.cos.ap-guangzhou.myqcloud.com/appid%2fsqlserver%2fmssql-mgq355n0%2fbackup%2fautoed_instance_58037_20200728011545.bak.tar?sign=q-sign-algorithm%3dsha1%26q-ak%3d*************************%26q-sign-time%3d1596176966%3b1596177266%26q-key-time%3d1596176966%3b1596177266%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3d3ea8139b631fa13d54b2c03313cbf3850d1e0c2c",
        "RequestId": "3f49f6d4-692b-414b-999c-55b38922e049",
        "Size": 1356532,
        "StartTime": "2020-07-31 14:28:51",
        "Status": 1,
        "Strategy": 0,
        "GroupId": "558800"
    }
}

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
FailedOperation.DBError Database error.
InternalError.CosError COS API error.
InternalError.DBError Database error
InvalidParameter.InputIllegal Input error.
ResourceNotFound.BackupNotFound The backup does not exist.
ResourceNotFound.InstanceNotFound The instance does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication error.
本页内容是否解决了您的问题？
您也可以 联系销售 或 提交工单 以寻求帮助。
是
否

文档反馈