文档中心

云数据库 PostgreSQL 版

任务管理

DescribeTasks

DescribeTasks

调用 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	Array of String	否	Success	任务状态，取值： Canceled：已取消。 WaitStart：待执行。 WaitSwitch：待切换。 Running：运行中。 Running_BeforeSwitch：运行中-切换前。 Running_Switching：运行中-切换中。 Running_AfterSwitch：运行中-切换后。 Success：成功。 Failed：失败。 Timeout：超时。 Rollbacking：回滚中。 RollbackFailed：回滚失败。 Paused：已暂停。
ProjectName	String	否	default	项目名称。

返回参数

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

TaskInfoObject

参数	类型	示例值	描述
CostTimeMS	Long	11990	任务耗时。单位为毫秒。
CreateTime	String	2025-09-10T13:53:27Z	任务的创建时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
FinishTime	String	2025-09-10T13:53:39Z	任务的完成时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
InstanceId	String	postgres-2904ed64****	任务相关实例的 ID。
ProjectName	String	default	项目名称。
Region	String	cn-beijing	任务所属的地域。
ScheduledSwitchEndTime	String	2025-09-20T17:59:00Z	计划切换的截止时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明仅处于“等待开始”、“等待执行”或“等待切换”状态的任务会返回该字段。
ScheduledSwitchStartTime	String	2025-09-20T16:00:00Z	计划切换的起始时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明仅处于“等待开始”、“等待执行”或“等待切换”状态的任务会返回该字段。
TaskAction	String	AssociateAllowList	任务对应的 Open API 的名称。
TaskId	String	20250910215326D9573E9EDB8708234022-3202e3	任务 ID。
TaskParams	String	{"InstanceId":"postgres-2904ed64**","EndpointId":"postgres-2904ed64**-custom-bf14"}	任务参数。
TaskStatus	String	Success	任务状态，取值： Canceled：已取消。 WaitStart：待执行。 WaitSwitch：待切换。 Running：运行中。 Running_BeforeSwitch：运行中-切换前。 Running_Switching：运行中-切换中。 Running_AfterSwitch：运行中-切换后。 Success：成功。 Failed：失败。 Timeout：超时。 Rollbacking：回滚中。 RollbackFailed：回滚失败。 Paused：已暂停。

示例

请求示例

返回示例

最近更新时间：2026.03.31 10:39:12

这个页面对您有帮助吗？

有用

有用

无用

无用