首页 云数据库 RDS 开发参考 API参考 API目录 其他 DescribeHistoryTasks - 查询历史运维任务

DescribeHistoryTasks - 查询历史运维任务

更新时间: 2023-09-26 15:15:18

获取历史任务记录,支持创建时间30天内的任务。

接口说明

使用本接口可以查询任务列表,并且只支持查询创建时间在30天内的任务,与在控制台任务中心看到的结果相同。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeHistoryTasksRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

待处理事件所属的地域ID,可调用 DescribeRegions 接口获取。

cn-beijing
PageSizeinteger

每页记录数,取值:10~100。默认值:10

10
PageNumberinteger

查询结果的页码。取值范围:正整数。 默认值:1

1
InstanceTypestring

当前只支持 Instance。

Instance
Statusstring

任务状态,用于选择对应状态的任务:

  • Scheduled - 等待执行
  • Running - 执行中
  • Succeed - 执行成功
  • Failed - 执行失败
  • Cancelling - 正在终止
  • Canceled - 已终止
  • Waiting - 等待预设时间

如有多个状态则用英文逗号分隔,默认为空,表示全选。

Scheduled
InstanceIdstring

实例ID,用于查询对应实例的任务,如有多个用英文逗号分隔,最多支持30个,默认为空,表示不限制。

rm-uf62br2491p5l****
TaskIdstring

任务ID,用于查询已知ID的任务,如有多个英文用逗号分隔,最多支持30个,默认为空,表示不限制。

t-83br18hloy3faf****
TaskTypestring

任务类型,用于查询特定类型任务情况,如有多个用英文逗号分隔,最多支持30个,默认为空,表示不限制。

autotest_dispatch_cases
FromStartTimestring

任务开始时间的起始时间,表示查询任务开始时间在此时间之后的任务。按照ISO8601标准表示,并需要使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。最早支持30天前,距当前时间超过30天会自动转换成30天前。

2022-01-02T11:31:03Z
ToStartTimestring

任务开始时间的结束时间,表示查询任务开始时间在此时间之前的任务。按照ISO8601标准表示,并需要使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

2022-03-02T11:31:03Z
FromExecTimeinteger

任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务,单位秒。默认0,表示不限制。

0
ToExecTimeinteger

任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务,单位秒。默认0,表示不限制。

0
ResourceGroupIdstring

资源组ID。

rg-ae****

返回参数

名称类型描述示例值
object
PageNumberinteger

查询结果的页码。取值范围:正整数。 默认值:1

1
RequestIdstring

请求唯一ID,如果遇到问题请提供这个请求ID,由工作人员为您排查。

5CD61041-35F7-10F7-BE94-33A48B22****
PageSizeinteger

每页记录数,取值:10~100。默认值:10

10
TotalCountinteger

不考虑分页因素,满足这些限制条件的总任务数。

2
Itemsobject []

任务列表。

Statusinteger

任务状态。

  • Scheduled - 等待执行
  • Running - 执行中
  • Succeed - 执行成功
  • Failed - 执行失败
  • Cancelling - 正在终止
  • Canceled - 已终止
  • Waiting - 等待预设时间
Running
TaskIdstring

任务ID,格式t-***

t-83br18hloy3faf****
CurrentStepNamestring

当前执行的步骤名,如果为空代表任务未开始。

exec_task
StartTimestring

任务开始时间 UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

2022-02-03T11:31:03Z
EndTimestring

任务结束时间 UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

2022-02-03T12:06:17Z
TaskTypestring

任务类型/任务名称。

autotest_dispatch_cases
RemainTimeinteger

预估剩余执行时间,单位秒。

1000
Progressfloat

当前进度,0~100。

79.0
RegionIdstring

区域。

cn-shanghai
InstanceTypestring

实例类型,Eg. Instance 用户实例。

Instance
InstanceIdstring

实例ID,Eg. rm-xxx。

rm-uf62br2491p5l****
InstanceNamestring

实例名,用户自定义别名。

成本预测-20220509
DbTypestring

DB类型。

mysql
Productstring

产品, rds等。

rds
TaskDetailstring

详情,JSON String 可扩展。 不同taskType对应不同的输出。

{\"callerUid\":\"test\"}
ReasonCodestring

当前任务发起的原因。

ActionInfostring

允许的操作信息,具体使用时是根据currentStepName+status在此信息中匹配操作Action,如果未匹配到Action,代表任务当前状态不支持操作,示例:

  "steps": [
    {
      "step_name": "exec_task", // 步骤名, 与currentStepName匹配
      "action_info": {    // 步骤支持的操作
        "Waiting": [      // 状态,与status匹配
          "modifySwitchTime" // 操作Action,可能多个,即代表支持多个操作
        ]
      }
    },
    {
      "step_name": "init_task", // 步骤名
      "action_info": {    // 步骤支持的操作
        "Running": [      // 状态
          "cancel",       // 操作
          "pause"
        ]
      }
    }
  ]
}

系统可能支持的操作: retry - 重试 cancel - 取消 modifySwitchTime - 修改切换时间/恢复时间

{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}
Uidstring

资源所属用户ID。

141345906006****
CallerSourcestring

请求用户ID,callerSource为User时代表用户UID。

141345906006****
CallerUidstring

请求来源 System:系统 User:用户。

User

示例

正常返回示例

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错误码错误信息描述
400Param.InvalidParam invalid请求参数错误
400Param.Invalid.TimeEndBeforeStartParam invalid. End time before start time参数错误,结束时间早于开始时间

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

变更历史

变更时间变更内容概要操作
2022-06-20新增 OpenAPI看变更集
阿里云首页 云数据库 RDS 相关技术圈