云数据库 SQL Server
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云数据库 SQL Server > API 文档 > 回档相关接口 > 查询回档任务列表

查询回档任务列表

最近更新时间：2024-03-12 01:47:22

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeRestoreTask）用于查询回档任务列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRestoreTask。
Version 是 String 公共参数，本接口取值：2018-03-28。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 源实例ID
示例值：mssql-8943uijh21
StartTime 是 String 开始时间
示例值：2023-01-01 12:00:00
EndTime 是 String 结束时间
示例值：2023-01-01 13:00:00
RestoreType 否 Integer 回档方式，0-按照时间点回档，1-按照备份集回档
示例值：1
TargetRegion 否 String 回档的目标实例所在地域
示例值：ap-shanghai
TargetType 否 Integer 回档到目标实例的类型，0-当前实例，1-已有实例，2-全新实例
示例值：0
Status 否 Integer 回档状态，0-初始化，1-运行中，2-成功，3-失败
示例值：2
Offset 否 Integer 分页返回，每页返回的数目，取值为1-100，默认值为20
示例值：0
Limit 否 Integer 分页返回，页编号，默认值为第0页
示例值：20
OrderBy 否 String 排序字段，restoreTime-回档时间，startTime-任务开始时间，endTime-任务结束时间，默认按照任务开始时间降序
示例值：startTime
OrderByType 否 String 排序规则（desc-降序，asc-升序），默认desc
示例值：desc

3. 输出参数

参数名称 类型 描述
TotalCount Integer 回档任务总数量
示例值：1
Tasks Array of RestoreTask 回档任务记录列表
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询回档任务列表

查询回档任务列表

输入示例

POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRestoreTask
<公共请求参数>

{
    "InstanceId": "mssql-aju981jo",
    "RestoreType": 0,
    "TargetRegion": "ap-shanghai",
    "TargetType": 2,
    "Status": 1,
    "StartTime": "2023-04-12: 00:00:00",
    "EndTime": "2023-04-12: 00:00:00",
    "Offset": 0,
    "Limit": 10,
    "OrderBy": "startTime",
    "OrderByType": "desc"
}

输出示例

{
    "Response": {
        "RequestId": "88310080-925d-11ed-981b-c7bf72df626c",
        "Tasks": [
            {
                "TargetInstanceId": "mssql-892932uiu",
                "TargetInstanceName": "test",
                "TargetInstanceStatus": 2,
                "TargetRegion": "ap-guangzhou",
                "TargetType": 0,
                "EndTime": "0000-00-00 00:00:00",
                "RestoreId": 1012,
                "RestoreTime": "2023-01-12 16:22:48",
                "RestoreType": 0,
                "StartTime": "2023-01-12 16:22:55",
                "Status": 0
            }
        ],
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DBError 数据库错误。
FailedOperation.GcsError 操作失败或者网络超时。
InvalidParameter.InputIllegal 输入错误。
ResourceNotFound.InstanceNotFound 实例不存在。
UnauthorizedOperation.PermissionDenied cam鉴权错误。
中国站