DescribeTasks--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

DescribeTasks

最近更新时间：2025.10.14 14:43:15首次发布时间：2025.10.14 14:43:15

调用 DescribeTasks 接口查询任务。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
PageNumber	Integer	是	1	当前页页码。最小值为 1。
PageSize	Integer	是	100	每页记录数。最小值为 1，最大值不超过 1000。
InstanceId	String	否	postgres-2904ed64****	实例 ID。
TaskId	String	否	202509102225598DA116E6B90D38F149EA-9f0b91	任务 ID。
TaskAction	String	否	ModifyDBInstanceSSL	任务对应的 Action，一般为与任务相应的 Open API 的 Action。
CreationStartTime	String	否	2025-09-04T21:30:00Z	任务的开始时间。时间格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。说明任务时间（CreationStartTime 和 CreationEndTime）与 TaskId 两组参数，二者必选其一。任务开始时间（CreationStartTime）与任务结束时间（CreationEndTime）的最大时间间隔不能超过 7 天。
CreationEndTime	String	否	2025-09-10T23:40:00Z	任务的结束时间。时间格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC 时间）。说明任务时间（CreationStartTime 和 CreationEndTime）与 TaskId 两组参数，二者必选其一。任务开始时间（CreationStartTime）与任务结束时间（CreationEndTime）的最大时间间隔不能超过 7 天。
TaskStatus	String[]	否	Success	任务状态，取值： `Canceled`：已取消。 `WaitStart`：待执行。 `WaitSwitch`：待切换。 `Running`：运行中。 `Running_BeforeSwitch`：运行中-切换前。 `Running_Switching`：运行中-切换中。 `Running_AfterSwitch`：运行中-切换后。 `Success`：成功。 `Failed`：失败。 `Timeout`：超时。 `Rollbacking`：回滚中。 `RollbackFailed`：回滚失败。 `Paused`：已暂停。
ProjectName	String	否	default	项目名称。

返回参数

参数	类型	示例值	描述
TaskInfos	Object[]	请参见返回示例。	任务的详细信息。
Total	Integer	123	符合查询条件的任务数量。

示例

请求示例

POST /?Action=DescribeTasks&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "PageNumber": 1,
    "PageSize": 5,
    "CreationEndTime": "2025-09-11T23:40:00Z",
    "CreationStartTime": "2025-09-10T21:30:00Z"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250911131641D9E1CECC49958E281C7B-15c708",
        "Action": "DescribeTasks",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "TaskInfos": [
            {
                "CostTimeMS": 3235,
                "CreateTime": "2025-09-11T05:16:15Z",
                "FinishTime": "2025-09-11T05:16:18Z",
                "InstanceId": "postgres-635ef13f0f47",
                "ProjectName": "default",
                "Region": "cn-beijing",
                "TaskAction": "ModifyDBInstanceConfig",
                "TaskId": "20250911131615549F0FE8E578FD2772B1-64727b",
                "TaskParams": "{\"InstanceId\":\"postgres-635ef13f****\",\"GlobalReadOnly\":true}",
                "TaskStatus": "Success"
            },
            {
                "CostTimeMS": 119,
                "CreateTime": "2025-09-11T05:15:38Z",
                "FinishTime": "2025-09-11T05:15:38Z",
                "InstanceId": "postgres-635ef13f****",
                "ProjectName": "default",
                "Region": "cn-beijing",
                "TaskAction": "CreateDatabase",
                "TaskId": "2025091113153732DF01B85B0733C564B7-98c665",
                "TaskParams": "{\"InstanceId\":\"postgres-635ef13f****\",\"DBName\":\"fnyql9p8\",\"CharacterSetName\":\"utf8\",\"Collate\":\"en_US.utf8\",\"CType\":\"en_US.utf8\"}",
                "TaskStatus": "Success"
            },
            {
                "CostTimeMS": 133,
                "CreateTime": "2025-09-11T05:15:24Z",
                "FinishTime": "2025-09-11T05:15:24Z",
                "InstanceId": "postgres-635ef13f****",
                "ProjectName": "default",
                "Region": "cn-beijing",
                "TaskAction": "ModifyDBInstanceName",
                "TaskId": "202509111315246CB6233D740D0BD25DC7-bf4064",
                "TaskParams": "{\"InstanceId\":\"postgres-635ef13f****\",\"InstanceNewName\":\"测试实例-kmjt5p\"}",
                "TaskStatus": "Success"
            },
            {
                "CostTimeMS": 77,
                "CreateTime": "2025-09-11T05:15:24Z",
                "FinishTime": "2025-09-11T05:15:24Z",
                "InstanceId": "postgres-deacd3e6****",
                "ProjectName": "default",
                "Region": "cn-beijing",
                "TaskAction": "ModifyDBInstanceName",
                "TaskId": "20250911131524889D767ED5A0B19477A9-953dbc",
                "TaskParams": "{\"InstanceId\":\"postgres-deacd3e6****\",\"InstanceNewName\":\"测试实例-nvmp96\"}",
                "TaskStatus": "Success"
            },
            {
                "CostTimeMS": 86,
                "CreateTime": "2025-09-11T05:15:24Z",
                "FinishTime": "2025-09-11T05:15:24Z",
                "InstanceId": "postgres-a3c2cffc****",
                "ProjectName": "default",
                "Region": "cn-beijing",
                "TaskAction": "ModifyDBInstanceName",
                "TaskId": "202509111315238BE74A8188414622A7FD-dcfc00",
                "TaskParams": "{\"InstanceId\":\"postgres-a3c2cffc****\",\"InstanceNewName\":\"测试实例-ns9wri\"}",
                "TaskStatus": "Success"
            }
        ],
        "Total": 198
    }
}