获取历史任务记录。
接口说明
仅支持查看 30 天内的任务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| adb:DescribeHistoryTasks | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 | cn-beijing |
| PageSize | integer | 否 | 每页记录数，取值：10~100。默认值：10。 | 10 |
| PageNumber | integer | 否 | 查询结果的页码。取值范围：正整数。 默认值：1。 | 1 |
| InstanceType | string | 否 | 实例类型，当前固定为 Instance。 | Instance |
| Status | string | 否 | 任务状态，取值说明：
如需查询多个状态则用英文逗号分隔，默认为空，表示全选。 | Scheduled |
| InstanceId | string | 否 | 集群 ID。多个集群 ID 用英文逗号（,）分隔。最多填写 30 个集群 ID。若不填写，则默认查询该地域下所有集群的历史任务。 | amv-******** |
| TaskId | string | 否 | 任务 ID。多个任务 ID 用英文逗号（,）分隔。最多填写 30 个任务 ID。若不填写，则默认查询所有集群的历史任务。 | t-83br18hloy3faf**** |
| TaskType | string | 否 | 任务类型，用于查询特定类型任务情况，如有多个用英文逗号（,）分隔，最多支持 30 个，默认为空，表示不限制。 | autotest_dispatch_cases |
| FromStartTime | string | 是 | 任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。 | 2022-01-02T11:31:03Z |
| ToStartTime | string | 是 | 任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 | 2022-03-02T11:31:03Z |
| FromExecTime | integer | 否 | 任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认 0，表示不限制。 | 0 |
| ToExecTime | integer | 否 | 任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认 0，表示不限制。 | 0 |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-ae**** |
返回参数
示例
正常返回示例
JSON格式
{
"PageNumber": 1,
"RequestId": "E51713A3-BB45-5616-AB15-170B704F8F01",
"PageSize": 10,
"TotalCount": 100,
"Items": [
{
"Status": "Running",
"TaskId": "t-83br18hloy3faf****",
"CurrentStepName": "exec_task",
"StartTime": "2022-02-03T11:31:03Z",
"EndTime": "2022-02-03T12:06:17Z",
"TaskType": "autotest_dispatch_cases",
"RemainTime": 1000,
"Progress": 79,
"RegionId": "cn-hangzhou",
"InstanceType": "Instance",
"InstanceId": "amv-********",
"InstanceName": "test",
"DbType": "analyticdb",
"Product": "ads",
"TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
"ActionInfo": "{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}",
"Uid": "141345906006****",
"CallerSource": "141345906006****",
"CallerUid": "User",
"ReasonCode": "test"
}
],
"Success": true,
"HttpStatusCode": 200,
"Code": 200,
"Message": "Success",
"AccessDeniedDetail": {
"AuthAction": "test",
"AuthPrincipalDisplayName": "test",
"AuthPrincipalOwnerId": "141345906006****",
"AuthPrincipalType": "test",
"EncodedDiagnosticMessage": "AQFmy+hZZsvoWTQ2NTJFQUFBLUIyNjktMzk5NS05MEZCLUMxMzgwNDUwMDA2Ng==",
"NoPermissionType": "ImplicitDeny",
"PolicyType": "ControlPolicy"
}
}错误码
访问错误中心查看更多错误码。