云数据库 PostgreSQL 查询任务列表-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（DescribeTasks）用于查询任务列表，展示异步任务的执行进度。
注：本接口中展示的步骤为总结性步骤，可能伴随着版本迭代进行调整，不建议作为关键逻辑使用

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTasks。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
TaskId	否	Integer	按照任务ID进行查询。其余云API中返回的FlowId和TaskId等价。示例值：120069
DBInstanceId	否	String	按照数据库实例ID进行查询。示例值：postgres-q6fj84vb
MinStartTime	否	String	任务的最早开始时间，形如2024-08-23 00:00:00,默认只展示180天内的数据。示例值：2024-09-23 00:00:00
MaxStartTime	否	String	任务的最晚开始时间，形如2024-08-23 00:00:00，默认为当前时间。示例值：2024-09-30 00:00:00
Limit	否	Integer	每页显示数量，取值范围为1-100，默认为返回20条。示例值：20
Offset	否	Integer	数据偏移量，从0开始。示例值：0
OrderBy	否	String	排序字段，支持StartTime,EndTime，默认为StartTime。示例值：StartTime
OrderByType	否	String	排序方式，包括升序：asc，降序：desc，默认为desc。示例值：asc

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	查询到的任务数量示例值：10
TaskSet	Array of TaskSet	任务信息列表示例值：[{"DBInstanceId":"postgres-bs9lnokj","EndTime":"2024-09-30 11:27:57","Progress":100,"StartTime":"2024-09-30 11:26:23","Status":"Success","TaskDetail":{"AllSteps":"","Input":"","Output":""},"TaskId":23,"TaskType":"RestartInstance"}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询最新1条任务记录

查询最新1条任务记录

输入示例

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

{
    "Limit": 1,
    "Offset": 0,
    "OrderBy": "StartTime",
    "OrderByType": "desc"
}

输出示例

{
    "Response": {
        "TaskSet": [
            {
                "TaskId": 1202345,
                "TaskType": "RestoreDatabase",
                "DBInstanceId": "postgres-q6fj84vb",
                "StartTime": "2024-09-27 13:14:11",
                "EndTime": "2024-09-27 13:18:11",
                "Status": "Success",
                "Progress": 100,
                "TaskDetail": {}
            }
        ],
        "RequestId": "3f164712-8746-464f-a490-3084a470000e",
        "TotalCount": 20
    }
}

示例2 查询指定任务ID的任务

查询指定任务ID的任务

输入示例

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

{
    "TaskId": 120321,
    "Limit": 1
}

输出示例

{
    "Response": {
        "RequestId": "7460a34c-2cf8-4d5c-9346-6977830da6e1",
        "TaskSet": [
            {
                "DBInstanceId": "postgres-0e3hth5b",
                "EndTime": "",
                "Progress": 0,
                "StartTime": "2024-09-27 16:06:02",
                "Status": "Running",
                "TaskDetail": {
                    "AllSteps": "",
                    "Input": "",
                    "Output": ""
                },
                "TaskId": 120321,
                "TaskType": "DestroyInstance"
            }
        ],
        "TotalCount": 1
    }
}

示例3 查询指定实例的任务

分页查询指定实例的所有任务

输入示例

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

{
    "DBInstanceId": "postgres-q6fj84vb",
    "Limit": 20
}

输出示例

{
    "Response": {
        "RequestId": "53872de1-b750-4aa4-b660-5a3627a44d34",
        "TaskSet": [
            {
                "DBInstanceId": "postgres-q6fj84vb",
                "EndTime": "2024-09-27 13:18:11",
                "Progress": 100,
                "StartTime": "2024-09-27 13:14:11",
                "Status": "Success",
                "TaskDetail": {
                    "AllSteps": "[{\"StepId\":1,\"StepName\":\"Pre-check\"},{\"StepId\":2,\"StepName\":\"Download Base Backup\",\"StepProcess\":100,\"StepMessage\":\"download cos file success, cost time:12 s\"},{\"StepId\":3,\"StepName\":\"Download WAL Logs and Redo\",\"StepProcess\":100,\"StepMessage\":\"specifyBackupSet type ,skip download wal log and redo step\"},{\"StepId\":4,\"StepName\":\"Execute Recovery\"},{\"StepId\":5,\"StepName\":\"Task Complete\"}]",
                    "CurrentStep": "Task Complete",
                    "Input": "{\"RestoreObjects\":[\"postgres\"],\"RestoreType\":\"specifyBackupSet\",\"BackupSetTime\":\"2024-09-26 19:11:45\"}",
                    "Output": "{\"BeforeRestoreObjects\":[\"postgres\"],\"AfterRestoreObjects\":[\"postgres_bak_1727414053\"],\"RestoreType\":\"specifyBackupSet\",\"BackupSetTime\":\"2024-09-26 19:11:45\",\"Message\":\"success\"}"
                },
                "TaskId": 120006,
                "TaskType": "RestoreDatabase"
            },
            {
                "DBInstanceId": "postgres-q6fj84vb",
                "EndTime": "2024-09-27 13:13:31",
                "Progress": 100,
                "StartTime": "2024-09-27 13:09:15",
                "Status": "Success",
                "TaskDetail": {
                    "AllSteps": "[{\"StepId\":1,\"StepName\":\"Pre-check\"},{\"StepId\":2,\"StepName\":\"Download Base Backup\",\"StepProcess\":100,\"StepMessage\":\"download cos file success, cost time:11 s\"},{\"StepId\":3,\"StepName\":\"Download WAL Logs and Redo\",\"StepProcess\":100,\"StepMessage\":\"specifyBackupSet type ,skip download wal log and redo step\"},{\"StepId\":4,\"StepName\":\"Execute Recovery\"},{\"StepId\":5,\"StepName\":\"Task Complete\"}]",
                    "CurrentStep": "Task Complete",
                    "Input": "{\"RestoreObjects\":[\"postgres\"],\"RestoreType\":\"specifyBackupSet\",\"BackupSetTime\":\"2024-09-26T19:11:45+08:00\"}",
                    "Output": "{\"BeforeRestoreObjects\":[\"postgres\"],\"AfterRestoreObjects\":[\"postgres_bak_1727413757\"],\"RestoreType\":\"specifyBackupSet\",\"BackupSetTime\":\"2024-09-26T19:11:45+08:00\",\"Message\":\"success\"}"
                },
                "TaskId": 120005,
                "TaskType": "RestoreDatabase"
            },
            {
                "DBInstanceId": "postgres-q6fj84vb",
                "EndTime": "2024-09-27 12:35:58",
                "Progress": 100,
                "StartTime": "2024-09-27 12:31:50",
                "Status": "Success",
                "TaskDetail": {
                    "AllSteps": "[{\"StepId\":1,\"StepName\":\"Pre-check\"},{\"StepId\":2,\"StepName\":\"Download Base Backup\",\"StepProcess\":100,\"StepMessage\":\"download cos file success, cost time:1 s\"},{\"StepId\":3,\"StepName\":\"Download WAL Logs and Redo\",\"StepProcess\":100,\"StepMessage\":\"specifyBackupSet type ,skip download wal log and redo step\"},{\"StepId\":4,\"StepName\":\"Execute Recovery\"},{\"StepId\":5,\"StepName\":\"Task Complete\"}]",
                    "CurrentStep": "Task Complete",
                    "Input": "{\"RestoreObjects\":[\"postgres\"],\"RestoreType\":\"specifyBackupSet\"}",
                    "Output": "{\"BeforeRestoreObjects\":[\"postgres\"],\"AfterRestoreObjects\":[\"postgres_bak_1727411512\"],\"RestoreType\":\"specifyBackupSet\",\"Message\":\"success\"}"
                },
                "TaskId": 120004,
                "TaskType": "RestoreDatabase"
            },
            {
                "DBInstanceId": "postgres-q6fj84vb",
                "EndTime": "2024-09-27 12:31:28",
                "Progress": 100,
                "StartTime": "2024-09-27 12:30:06",
                "Status": "Success",
                "TaskDetail": {
                    "AllSteps": "[{\"StepId\":1,\"StepName\":\"Pre-check\"},{\"StepId\":2,\"StepName\":\"Download Base Backup\"},{\"StepId\":3,\"StepName\":\"Download WAL Logs and Redo\"},{\"StepId\":4,\"StepName\":\"Execute Recovery\"},{\"StepId\":5,\"StepName\":\"Task Complete\"}]",
                    "CurrentStep": "Task Complete",
                    "Input": "{\"RestoreObjects\":[\"postgres\"],\"RestoreType\":\"timestamp\",\"RestoreTargetTime\":\"2024-09-26 15:20:14\"}",
                    "Output": "{\"BeforeRestoreObjects\":[\"postgres\"],\"AfterRestoreObjects\":[\"postgres_bak_1727411408\"],\"RestoreType\":\"timestamp\",\"RestoreTargetTime\":\"2024-09-26 15:20:14\",\"Message\":\"success\"}"
                },
                "TaskId": 120003,
                "TaskType": "RestoreDatabase"
            },
            {
                "DBInstanceId": "postgres-q6fj84vb",
                "EndTime": "2024-09-27 12:29:04",
                "Progress": 100,
                "StartTime": "2024-09-27 12:24:29",
                "Status": "Success",
                "TaskDetail": {
                    "AllSteps": "[{\"StepId\":1,\"StepName\":\"Pre-check\"},{\"StepId\":2,\"StepName\":\"Download Base Backup\"},{\"StepId\":3,\"StepName\":\"Download WAL Logs and Redo\"},{\"StepId\":4,\"StepName\":\"Execute Recovery\"},{\"StepId\":5,\"StepName\":\"Task Complete\"}]",
                    "CurrentStep": "Task Complete",
                    "Input": "{\"RestoreObjects\":[\"postgres\"],\"RestoreType\":\"timestamp\",\"RestoreTargetTime\":\"2024-09-26 15:20:14\"}",
                    "Output": "{\"BeforeRestoreObjects\":[\"postgres\"],\"AfterRestoreObjects\":[\"postgres_bak_1727411071\"],\"RestoreType\":\"timestamp\",\"RestoreTargetTime\":\"2024-09-26 15:20:14\",\"Message\":\"success\"}"
                },
                "TaskId": 120002,
                "TaskType": "RestoreDatabase"
            },
            {
                "DBInstanceId": "postgres-q6fj84vb",
                "EndTime": "2024-09-27 11:32:50",
                "Progress": 100,
                "StartTime": "2024-09-27 11:29:03",
                "Status": "Success",
                "TaskDetail": {
                    "AllSteps": "[{\"StepId\":1,\"StepName\":\"Pre-check\"},{\"StepId\":2,\"StepName\":\"Download Base Backup\",\"StepProcess\":100,\"StepMessage\":\"download cos file success, cost time:1 s\"},{\"StepId\":3,\"StepName\":\"Download WAL Logs and Redo\",\"StepProcess\":100,\"StepMessage\":\"specifyBackupSet type ,skip download wal log and redo step\"},{\"StepId\":4,\"StepName\":\"Execute Recovery\"},{\"StepId\":5,\"StepName\":\"Task Complete\"}]",
                    "CurrentStep": "Task Complete",
                    "Input": "{\"RestoreObjects\":[\"postgres\"],\"RestoreType\":\"specifyBackupSet\",\"BackupSetId\":\"17083520-3ce6-5b50-9c25-73ff3d4d80b7\"}",
                    "Output": "{\"RestoreObjects\":[\"postgres\"],\"RestoreType\":\"specifyBackupSet\",\"BackupSetId\":\"17083520-3ce6-5b50-9c25-73ff3d4d80b7\",\"RestoreTargetTime\":\"1970-01-01 08:00:00\",\"Message\":\"success\"}"
                },
                "TaskId": 120001,
                "TaskType": "RestoreDatabase"
            }
        ],
        "TotalCount": 6
    }
}

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.DatabaseAccessError	管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.DatabaseAffectedError	数据操作失败，请联系客服进行处理。
FailedOperation.FailedOperationError	操作失败，请稍后重试。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
InvalidParameterValue.ParameterValueExceedError	参数值超过上限。

查询任务列表

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 查询最新1条任务记录

输入示例

输出示例

示例2 查询指定任务ID的任务

输入示例

输出示例

示例3 查询指定实例的任务

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码