DescribeHistoryTasks - 查询历史任务-阿里云帮助中心

PolarDB MySQL 查询历史任务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeHistoryTasks

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。说明可通过接口 DescribeRegions 查看地域信息详情。	cn-beijing
PageSize	integer	否	每页记录数，取值：10~100。默认值：10。	10
PageNumber	integer	否	查询结果的页码。取值范围：正整数。默认值：1。	1
InstanceType	string	否	当前只支持 Instance。	Instance
Status	string	否	任务状态，取值范围如下： Scheduled：等待执行 Running：执行中 Succeed：执行成功 Cancelling：正在终止 Canceled：已终止 Waiting：等待预设时间如需查询多个状态则用英文逗号分隔，默认为空，表示全选。	Running
InstanceId	string	否	资源 ID。用于查询对应资源的任务，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。说明目前只支持集群 ID。	pc-2zed3m89cw***
TaskId	string	否	任务 ID。如有多个任务 ID，使用英文用逗号分隔，最多支持 30 个，默认为空，表示不限制。	t-0mqi38ho0cgjv***
TaskType	string	否	任务类型，用于查询特定类型任务情况，如有多个用英文逗号分隔，最多支持 30 个，默认为空，表示不限制。	ChangeVariable
FromStartTime	string	是	任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 `UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。	2025-01-02T11:31:03Z
ToStartTime	string	是	任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用`UTC+0` 时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`。	2025-01-03T11:31:03Z
FromExecTime	integer	否	任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认 0，表示不限制。	0
ToExecTime	integer	否	任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认 0，表示不限制。	0
ResourceGroupId	string	否	资源组 ID。	rg-************

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
PageNumber	integer	查询结果的页码。	1
RequestId	string	请求唯一 ID。	F90D7C14-2D1C-5B88-9CD1-23AB2CF89***
PageSize	integer	每页记录数。	10
TotalCount	string	不考虑分页因素，满足这些限制条件的总任务数。	2
Items	array<object>	任务列表。
	object	任务对象。
Status	string	任务状态。 Scheduled：等待执行 Running：执行中 Succeed：执行成功 Failed：执行失败 Cancelling：正在终止 Canceled：已终止 Waiting：等待预设时间	Succeed
TaskId	string	任务 ID。	t-0mqt8qhnw04ipz0***
CurrentStepName	string	当前执行的步骤名，如果为空代表任务未开始。	finish_task
StartTime	string	任务开始时间。	2025-03-03T07:25:16Z
EndTime	string	任务结束时间。	2025-03-03T07:30:57Z
TaskType	string	任务类型。	ChangeVariable
RemainTime	integer	预估剩余执行时间，单位为秒（s）。说明该值仅供参考，请以实际执行时间为准。	0
Progress	number	当前进度。	100.0
RegionId	string	地域 ID。	cn-beijing
InstanceType	string	资源类型。	Instance
InstanceId	string	资源 ID。	pc-2zed3m89cw***
InstanceName	string	资源名称。	pc-2zed3m89cw***
DbType	string	数据库类型。	polardb_mysql
Product	string	产品。	polardb
TaskDetail	string	任务详情。	{\"steps\":[{\"step_name\":\"init_task\"},{\"step_name\":\"exec_task\"},{\"step_name\":\"finish_task\"}]}
ReasonCode	string	当前任务发起的原因。	""
ActionInfo	string	允许的操作信息。说明目前暂未支持。	{}
Uid	string	资源所属用户 ID。	1816563541899***
CallerSource	string	请求来源，取值说明： System：系统 User：用户	User
CallerUid	string	请求用户 ID，CallerSource 为 User 时代表用户 UID。	1816563541899***

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "F90D7C14-2D1C-5B88-9CD1-23AB2CF89***",
  "PageSize": 10,
  "TotalCount": "2",
  "Items": [
    {
      "Status": "Succeed",
      "TaskId": "t-0mqt8qhnw04ipz0***",
      "CurrentStepName": "finish_task",
      "StartTime": "2025-03-03T07:25:16Z",
      "EndTime": "2025-03-03T07:30:57Z",
      "TaskType": "ChangeVariable",
      "RemainTime": 0,
      "Progress": 100,
      "RegionId": "cn-beijing",
      "InstanceType": "Instance",
      "InstanceId": "pc-2zed3m89cw***",
      "InstanceName": "pc-2zed3m89cw***",
      "DbType": "polardb_mysql",
      "Product": "polardb",
      "TaskDetail": "{\\\"steps\\\":[{\\\"step_name\\\":\\\"init_task\\\"},{\\\"step_name\\\":\\\"exec_task\\\"},{\\\"step_name\\\":\\\"finish_task\\\"}]}",
      "ReasonCode": "\"\"",
      "ActionInfo": "{}",
      "Uid": "1816563541899***",
      "CallerSource": "User",
      "CallerUid": "1816563541899***"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	Param.Invalid	The parameter is invalid.	参数无效。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。