获取历史任务记录,支持创建时间30天内的任务。
接口说明
使用本接口可以查询任务列表,并且只支持查询创建时间在30天内的任务,与在控制台任务中心看到的结果相同。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeHistoryTasks | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 待处理事件所属的地域ID,可调用 DescribeRegions 接口获取。 | cn-beijing |
PageSize | integer | 否 | 每页记录数,取值:10~100。默认值:10。 | 10 |
PageNumber | integer | 否 | 查询结果的页码。取值范围:正整数。 默认值:1。 | 1 |
InstanceType | string | 否 | 当前只支持 Instance。 | Instance |
Status | string | 否 | 任务状态,用于选择对应状态的任务:
如有多个状态则用英文逗号分隔,默认为空,表示全选。 | Scheduled |
InstanceId | string | 否 | 实例ID,用于查询对应实例的任务,如有多个用英文逗号分隔,最多支持30个,默认为空,表示不限制。 | rm-uf62br2491p5l**** |
TaskId | string | 否 | 任务ID,用于查询已知ID的任务,如有多个英文用逗号分隔,最多支持30个,默认为空,表示不限制。 | 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": "5CD61041-35F7-10F7-BE94-33A48B22****",
"PageSize": 10,
"TotalCount": 2,
"Items": [
{
"Status": 0,
"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-shanghai",
"InstanceType": "Instance",
"InstanceId": "rm-uf62br2491p5l****",
"InstanceName": "成本预测-20220509",
"DbType": "mysql",
"Product": "rds",
"TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
"ReasonCode": " ",
"ActionInfo": "{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}",
"Uid": "141345906006****",
"CallerSource": "141345906006****",
"CallerUid": "User"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Param.Invalid | Param invalid | 请求参数错误 |
400 | Param.Invalid.TimeEndBeforeStart | Param invalid. End time before start time | 参数错误,结束时间早于开始时间 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-06-20 | 新增 OpenAPI | 看变更集 |