云数据库 SQL Server 根据流程ID查询备份信息-备份相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： sqlserver.tencentcloudapi.com 。

本接口(DescribeBackupByFlowId)用于通过备份创建流程的ID查询创建的备份详情，流程ID可从接口CreateBackup中获得。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBackupByFlowId。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID，格式如：mssql-3l3fgqn7 示例值：mssql-6upluvd5
FlowId	是	String	创建备份流程ID，可通过 CreateBackup 接口获取示例值：1000797

3. 输出参数

参数名称	类型	描述
Id	Integer	备份文件唯一标识，RestoreInstance接口会用到该字段，对于单库备份文件只返回第一条记录的备份文件唯一标识；单库备份文件需要通过DescribeBackupFiles接口获取全部记录的可回档的ID 示例值：1234568
FileName	String	文件名，对于单库备份文件只返回第一条记录的文件名；单库备份文件需要通过DescribeBackupFiles接口获取全部记录的文件名示例值：autoed_instance_58037_20200728011545.bak.tar
BackupName	String	备份任务名称，可自定义示例值：mssql-6upluvd5_202007311206
StartTime	Timestamp	备份开始时间示例值：2020-07-31 14:28:51
EndTime	Timestamp	备份结束时间示例值：2020-07-31 15:10:27
Size	Integer	文件大小，单位 KB，对于单库备份文件只返回第一条记录的文件大小；单库备份文件需要通过DescribeBackupFiles接口获取全部记录的文件大小示例值：1356532
Strategy	Integer	备份策略，0-实例备份；1-多库备份；实例状态是0-创建中时，该字段为默认值0，无实际意义示例值：0
Status	Integer	备份文件状态，0-创建中；1-成功；2-失败示例值：1
BackupWay	Integer	备份方式，0-定时备份；1-手动临时备份；实例状态是0-创建中时，该字段为默认值0，无实际意义示例值：0
DBs	Array of String	DB列表，对于单库备份文件只返回第一条记录包含的库名；单库备份文件需要通过DescribeBackupFiles接口获取全部记录的库名。示例值：["db1","db2"]
InternalAddr	String	内网下载地址，对于单库备份文件只返回第一条记录的内网下载地址；单库备份文件需要通过DescribeBackupFiles接口获取全部记录的下载地址示例值：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*************************%3b1596177266%26q-key-time%3d1596176966%3b1596177266%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3d3ea8139b631fa13d54b2c03313cbf3850d1e0c2c
ExternalAddr	String	外网下载地址，对于单库备份文件只返回第一条记录的外网下载地址；单库备份文件需要通过DescribeBackupFiles接口获取全部记录的下载地址示例值：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
GroupId	String	聚合Id，对于打包备份文件不返回此值。通过此值调用DescribeBackupFiles接口，获取单库备份文件的详细信息示例值：558800
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 流程ID查询备份详情（备份创建中）

流程ID查询备份详情（备份创建中）

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupByFlowId
&InstanceId=mssql-6upluvd5
&FlowId=1000796
&<公共请求参数>

输出示例

{
    "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"
    }
}

示例2 流程ID查询备份详情（备份已完成）

流程ID查询备份详情（备份已完成）

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupByFlowId
&InstanceId=mssql-6upluvd5
&FlowId=1000797
&<公共请求参数>

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DBError	数据库错误。
InternalError.CosError	COS接口错误。
InternalError.DBError	数据库错误。
InvalidParameter.InputIllegal	输入错误。
ResourceNotFound.BackupNotFound	备份不存在。
ResourceNotFound.InstanceNotFound	实例不存在。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

根据流程ID查询备份信息

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 流程ID查询备份详情（备份创建中）

输入示例

输出示例

示例2 流程ID查询备份详情（备份已完成）

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码