DescribeTosRestoreTasks--云数据库 SQL Server 版-火山引擎

文档中心

立即注册

导航

DescribeTosRestoreTasks

最近更新时间：2024.11.21 09:55:32首次发布时间：2023.08.25 11:59:39

调用 DescribeTosRestoreTasks 接口查询实例备份数据上云任务列表。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
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:01:00.000Z	查询任务创建的开始时间。格式：yyyy-MM-ddTHH:mm:sssZ（UTC 时间）。
QueryEndTime	String	否	2023-08-25T01:03:00.000Z	查询任务创建的结束时间。格式：yyyy-MM-ddTHH:mm:sssZ（UTC 时间）。说明查询结束时间需晚于查询开始时间。
ProjectName	String	否	default	项目名称。当您的账号为子用户时，在调用接口时必须传入该参数进行账号鉴权，否则将无法成功调用接口。主账户默认拥有所有权限，则无需传入此参数。

返回参数

名称	类型	示例值	描述
Total	Integer	1	恢复任务总数。
RestoreTasks	Array of RestoreTaskObject	RestoreTaskObject	恢复任务列表。

请求示例

POST /?Action=DescribeTosRestoreTasks&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.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":"2023-08-25T01:01:00.000Z",
    "QueryEndTime":"2023-08-25T01:03:01.000Z",
    "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
    }
}

错误码

更多详情，请参见错误码。