文档中心

云数据库 SQL Server 版

备份上云

DescribeTosRestoreTasks - 查询tos备份上云任务列表

查询实例备份数据上云任务列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeTosRestoreTasks

要执行的操作，取值：DescribeTosRestoreTasks。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

ProjectName string 可选示例值：default

项目名称。

说明

当您的账号为子用户时，在调用接口时必须传入该参数进行账号鉴权，否则将无法成功调用接口。主账户默认拥有所有权限，则无需传入此参数。

RestoreTaskIds string[] 可选示例值：["90", "100", "10" ]

恢复任务 ID。当传入多个恢复任务 ID 时，请使用英文逗号（,）隔开。

PageNumber integer 可选示例值：1

当前页查询偏移量。最小为 1，最大为 2147483647，默认值为 1。

PageSize integer 可选示例值：10

每页记录数。最小为 1，最大为 1000，默认值为 10。

InstanceId string 可选示例值：mssql-bbe31c86****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询实例 ID。

InstanceName string 可选示例值：testname

实例名称。

说明

您可以调用 DescribeDBInstances 接口查询实例名称。

QueryStartTime string 可选示例值：2023-08-25T01:03:00.000Z

查询任务创建的开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

QueryEndTime string 可选示例值：2023-08-25T01:00:01.000Z

查询任务创建的结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

说明

查询结束时间需晚于查询开始时间。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Total integer 示例值：1

恢复任务总数

RestoreTasks object[] 示例值：RestoreTaskObject

恢复任务列表。

RestoreTaskId string 示例值：90

恢复任务 ID。

InstanceId string 示例值：mssql-bbe31c86****

实例 ID。

InstanceName string 示例值：testname

实例名称。

TaskStartTime string 示例值：2023-08-22T09:51:00.000Z

任务开始时间：格式：yyyy-MM-ddTHH:mm:sssZ（UTC 时间）。

TaskEndTime string 示例值：2023-08-22T09:50:45.000Z

任务结束时间：格式：yyyy-MM-ddTHH:mm:sssZ（UTC 时间）。

TaskStatus string 示例值：Failed

任务状态，取值如下：

NoStart：表示任务未开始。

Running：表示任务运行中。

Success：表示任务执行成功。

Failed：表示任务执行失败。

说明

恢复失败的任务中可能也存在部分数据库恢复完成的场景，您可以调用 DescribeTosRestoreTaskDetail 接口查看更多详细信息。

TaskType string 示例值：OpenDB

任务类型，取值如下：

OpenDB：表示打开数据库。

NotOpenDB：表示不打开数据库。

RestoreType string 示例值：FULL

恢复类型。取值如下：

Full：表示全量恢复。

Diff：表示增量恢复。

LOG：表示日志恢复。

TaskDesc string 示例值：恢复文件校验失败

任务备份描述。

IsReplace boolean 示例值：false

表示恢复时不覆盖目标实例上已经存在的数据库，取值为false

请求示例

POST /?Action=DescribeTosRestoreTasks&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mssql.cn-beijing.volcengineapi.com​
X-Date: 20230131T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
​
{​
    "InstanceId": "mssql-bbe31c86****",​
    "InstanceName":"testname",​
    "QueryStartTime":"2020-03-01T00:00Z",​
    "QueryEndTime":"2024-03-01T12:00Z",​
    "PageNumber": 1,​
    "PageSize":100​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230823114957F13CF2FFF8431E8E50FC",​
        "Action": "DescribeTosRestoreTasks",​
        "Version": "2022-01-01",​
        "Service": "rds_mssql",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "RestoreTasks": [​
            {​
                "InstanceId": "mssql-bbe31c86****",​
                "InstanceName": "testname",​
                "IsReplace": false,​
                "RestoreTaskId": "90",​
                "RestoreType": "FULL",​
                "TaskDesc": "备份文件校验失败",​
                "TaskEndTime": "2023-08-22T09:51:00.000Z",​
                "TaskStartTime": "2023-08-22T09:50:45.000Z",​
                "TaskStatus": "Failed",​
                "TaskType": "OpenDB"​
            }​
        ],​
        "Total": 1​
    }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	OperationDenied_ImportJobExists	The operation is not permitted due to exist running import job.	当前实例正在执行数据导入任务，无法执行该操作。
400	UserBackupAmountOverTheLimit	The operation is not permitted due to the user backup amount over the limit.	手动备份的数量超过上限。
400	OperationDenied_BackupJobExists	The operation is not permitted due to exist running backup job.	当前实例正在执行备份任务，无法执行该操作。
400	OperationUnsupported	The operation is unsupported for the specified instance.	操作不支持。
400	InstanceIsNotRunning	The specified instance is not running.	当前实例状态不在运行中。
400	OperationDenied_IncrBackupUnsupportRecovery	The operation is not permitted due to incr backup unsupport recovery.	增量备份无法执行该操作。
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	缺少 {parameter1} 参数。
400	InvalidDBName_Duplicate	The specified DBName already exists.	数据库已存在。
400	TosRestoreTaskDbVerifyFailed	db verify failed, reason:%s.	DB 校验失败，原因是 {parameter1}。
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。
400	InvalidParameterFormat	The input parameter is not valid.	异常参数。
403	QuotaExceeded_RestoreDB	The quota of restore db exceeds.	恢复数据库超过配额限制。
403	OperationDenied_ResourceSoldOut	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	当前可用区资源不足。
404	BackupNotFound	The specified instance does not exist available backup records.	未找到可用的备份记录。
404	InstanceNotFound	The specified instance does not exist.	未找到该实例。
500	InternalError	The request has failed with internal server error.	内部错误。
500	TosRestoreTaskNumExceedLimit	Too many tasks are being executed. Please submit them later.	正在执行的任务数量过多，请稍后再提交。

最近更新时间：2025.12.01 18:11:12

这个页面对您有帮助吗？

有用

无用