AI 助理
备案控制台
文档
输入文档关键字查找
首页 云数据库 RDS 开发参考 API参考 API目录 事件与任务 DescribeHistoryTasks - 查询历史运维任务

DescribeHistoryTasks - 查询历史运维任务

更新时间：
产品详情
我的收藏

该接口用于获取历史任务记录，支持创建时间30天内的任务。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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，可调用 DescribeTasks 接口获取。如有多个任务 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

返回参数详情。

Itemsarray<object>

任务列表。

Itemsobject

任务对象。

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\"}]}
CallerSourcestring

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

141345906006****
CallerUidstring

请求来源，取值说明：

  • System：系统
  • User：用户
User
CurrentStepNamestring

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

exec_task
DbTypestring

数据库类型。

mysql
EndTimestring

任务结束时间。

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

实例 ID。

rm-uf62br2491p5l****
InstanceNamestring

实例名。

test
InstanceTypestring

实例类型。

Instance
Productstring

产品。

rds
Progressfloat

当前进度。

79.0
ReasonCodestring

当前任务发起的原因。

 ****
RegionIdstring

地域 ID。

cn-shanghai
RemainTimeinteger

预估剩余执行时间，单位为秒（s）。

1000
StartTimestring

任务开始时间。

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

任务状态。

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

任务详情。

{\"callerUid\":\"test\"}
TaskIdstring

任务 ID。

t-83br18hloy3faf****
TaskTypestring

任务类型。

autotest_dispatch_cases
Uidstring

资源所属用户 ID。

141345906006****
PageNumberinteger

查询结果的页码。

1
PageSizeinteger

每页记录数。

10
RequestIdstring

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

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

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

2

示例

正常返回示例

JSON格式

{
  "Items": [
    {
      "ActionInfo": "{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}",
      "CallerSource": "141345906006****",
      "CallerUid": "User",
      "CurrentStepName": "exec_task",
      "DbType": "mysql",
      "EndTime": "2022-02-03T12:06:17Z",
      "InstanceId": "rm-uf62br2491p5l****",
      "InstanceName": "test",
      "InstanceType": "Instance",
      "Product": "rds",
      "Progress": 79,
      "ReasonCode": " ****",
      "RegionId": "cn-shanghai",
      "RemainTime": 1000,
      "StartTime": "2022-02-03T11:31:03Z",
      "Status": "Running",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "TaskId": "t-83br18hloy3faf****",
      "TaskType": "autotest_dispatch_cases",
      "Uid": "141345906006****"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "5CD61041-35F7-10F7-BE94-33A48B22****",
  "TotalCount": 2
}

错误码

HTTP status code错误码错误信息描述
400Param.InvalidParam invalid请求参数错误
400Param.Invalid.TimeEndBeforeStartParam invalid. End time before start time参数错误，结束时间早于开始时间
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证，不符合购买条件，请登录费用与成本进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0，请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法，请重新购买。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好，该地域已裁撤。
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题，请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单，请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的账户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善，请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常，详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整，请在操作前填写您的信息。
400Api.NotSupportSpecified api is not supported.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签，请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.sql命令执行失败或执行超时
400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.当前实例引擎版本不支持归档冷数据。
400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.当前内核版本不支持归档冷数据。
400IncorrectTargetClasscodeThe current instance type does not support this operation.当前规格不支持此操作。
400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.链接地址名重复，请重新设置连接字符串。
400RequiredParam.NotFoundRequired input param is not found.没有传入必要的参数。
400Parameters.InvalidParameter error, please check the parameters.参数错误，请检查参数。
400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.数据归档不支持跨地域备份和秒级快照，请检查备份策略。
400InvalideStatus.FormatThe instance status does not support this operation.实例状态不支持此操作。
400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.实例释放后的归档备份保留策略无效。
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.DB实例引擎类型不支持此操作。
400Pay.NoCreditCardNo credit cards.无信用卡。
400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.vpc网络类型实例不支持此操作。
400MirrorInsExistsSpecified DB instance mirror ins already existed.当前数据库实例镜像已存在。
400UnsupportedClassCodeThe specified DB instance class stops selling.实例规格停止售卖。
400InvalidBackupSetThe specified database does not exist in the backup set.备份集中没有指定的数据库。
400OrdTCommodityQueryErrorFailed to query for product.查询产品失败。
400ProductInstanceReleasedThe instance has been released. Please check before placing the order.实例已释放，请核实后下单。
400RegionEndTimeDissolvedIndiaThe region is no longer supported.指定的地域无效。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单，请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作，请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
403OperationDenied.ZoneResourceThere is no available zone for inventory.没有可用的库存区域。
403NotInFlowControllerSorry,no permission.非集团上云用户不可用，无权限。
403InvalidKmsKeyKms key is disabled.Kms key已禁用。
403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.当前数据库实例级别不支持此操作。
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
404Request.NotFoundThe requested resource is not available.请求的资源不可用。
404HostInfo.NotFoundThe specified host info is not found.指定的主机信息不存在。
500ExternalFailureThe request processing has failed due to external service failure.请求服务失败，请稍后重试。
500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.请求服务失败，请稍后再试或联系服务人员。
500InvokeProxyFailureThe request processing has failed due to service failure of rds api.由于rds api服务失败，请求处理失败。

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

变更历史

变更时间变更内容概要操作
2023-11-20OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-06-20新增 OpenAPI查看变更详情
上一篇：DescribeHistoryTasksStat - 统计历史任务下一篇：ModifyTaskInfo - 修改任务信息