文档

DescribeHistoryTasks - 查询历史运维任务

更新时间:

查看任务中心的任务列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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 个。

r-uf62br2491p5l****
TaskIdstring

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

t-83br18hloy3faf****
TaskTypestring

任务类型,用于查询特定类型任务情况,默认为空,表示不限制,取值如下:

  • ModifyInsSpec:规格变更或迁移
  • DeleteInsNode:删除分片
  • AddInsNode:增加分片
  • HaSwitch:实例主备切换
  • RestartIns:重启实例
  • CreateIns:创建实例
  • ModifyInsConfig:配置变更
说明 如需查询多个请用英文逗号(,)分隔。
ModifyInsSpec
FromStartTimestring

查询任务的最早开始时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC 时间),最早支持查询 30 天前的数据。

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

查询任务的最晚开始时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC 时间),需晚于任务的最早开始时间。

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

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

0
ToExecTimeinteger

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

0

返回参数

名称类型描述示例值
object
PageNumberinteger

当前显示的页码。

1
RequestIdstring

请求 ID。

5D622714-AEDD-4609-9167-F5DDD3D1****
PageSizeinteger

每页显示的最大记录数。

10
TotalCountinteger

不考虑分页因素,满足查询条件的总任务数。

5
Itemsobject []

任务对象列表。

Statusinteger

任务状态。

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

任务 ID。

t-83br18hloy3faf****
CurrentStepNamestring

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

exec_task
StartTimestring

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

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

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

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

任务类型。

  • ModifyInsSpec:规格变更或迁移
  • DeleteInsNode:删除分片
  • AddInsNode:增加分片
  • HaSwitch:实例主备切换
  • RestartIns:重启实例
  • CreateIns:创建实例
  • ModifyInsConfig:配置变更
ModifyInsSpec
RemainTimeinteger

预估剩余执行时间,单位秒,0 表示已执行完成。

1000
Progressfloat

当前进度,范围为[0,100]。

79.0
RegionIdstring

地域 ID。

cn-shanghai
InstanceTypestring

实例类型,固定为 Instance。

Instance
InstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****
InstanceNamestring

实例名称。

dba-tair-test-qcloud
DbTypestring

DB 类型,固定为 redis。

redis
Productstring

产品,固定为 kvstore。

kvstore
TaskDetailstring

任务详情,不同 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": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "PageSize": 10,
  "TotalCount": 5,
  "Items": [
    {
      "Status": 0,
      "TaskId": "t-83br18hloy3faf****",
      "CurrentStepName": "exec_task",
      "StartTime": "2022-02-03T11:31:03Z",
      "EndTime": "2022-02-03T12:06:17Z",
      "TaskType": "ModifyInsSpec",
      "RemainTime": 1000,
      "Progress": 79,
      "RegionId": "cn-shanghai",
      "InstanceType": "Instance",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "InstanceName": "dba-tair-test-qcloud",
      "DbType": "redis",
      "Product": "kvstore",
      "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

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

变更历史

变更时间变更内容概要操作
暂无变更历史