DescribeHistoryTasks - 查询历史运维任务_云数据库 RDS(RDS)-阿里云帮助中心

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

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server

调试

您可以在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 - 等待执行 Running - 执行中 Succeed - 执行成功 Failed - 执行失败 Cancelling - 正在终止 Canceled - 已终止 Waiting - 等待预设时间如有多个状态则用英文逗号分隔，默认为空，表示全选。	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****

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
PageNumber	integer	查询结果的页码。取值范围：正整数。默认值：1。	1
RequestId	string	请求唯一 ID，如果遇到问题请提供这个请求 ID，由工作人员为您排查。	5CD61041-35F7-10F7-BE94-33A48B22****
PageSize	integer	每页记录数，取值：10~100。默认值：10。	10
TotalCount	integer	不考虑分页因素，满足这些限制条件的总任务数。	2
Items	object []	任务列表。
Status	string	任务状态。 Scheduled - 等待执行 Running - 执行中 Succeed - 执行成功 Failed - 执行失败 Cancelling - 正在终止 Canceled - 已终止 Waiting - 等待预设时间	Running
TaskId	string	任务 ID，格式 t-***	t-83br18hloy3faf****
CurrentStepName	string	当前执行的步骤名，如果为空代表任务未开始。	exec_task
StartTime	string	任务开始时间 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2022-02-03T11:31:03Z
EndTime	string	任务结束时间 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2022-02-03T12:06:17Z
TaskType	string	任务类型/任务名称。	autotest_dispatch_cases
RemainTime	integer	预估剩余执行时间，单位秒。	1000
Progress	float	当前进度，0～100。	79.0
RegionId	string	区域。	cn-shanghai
InstanceType	string	实例类型，Eg. Instance 用户实例。	Instance
InstanceId	string	实例 ID，Eg. rm-xxx。	rm-uf62br2491p5l****
InstanceName	string	实例名，用户自定义别名。	test
DbType	string	DB 类型。	mysql
Product	string	产品, rds 等。	rds
TaskDetail	string	详情，JSON String 可扩展。不同 taskType 对应不同的输出。	{\"callerUid\":\"test\"}
ReasonCode	string	当前任务发起的原因。	****
ActionInfo	string	允许的操作信息，具体使用时是根据 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\"}]}
Uid	string	资源所属用户 ID。	141345906006****
CallerSource	string	请求用户 ID，callerSource 为 User 时代表用户 UID。	141345906006****
CallerUid	string	请求来源 System：系统 User：用户。	User

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "5CD61041-35F7-10F7-BE94-33A48B22****",
  "PageSize": 10,
  "TotalCount": 2,
  "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-shanghai",
      "InstanceType": "Instance",
      "InstanceId": "rm-uf62br2491p5l****",
      "InstanceName": "test",
      "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	参数错误，结束时间早于开始时间
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐实例不允许单独操作。
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	定价计划价格结果没有找到。
400	Order.NoRealNameAuthentication	You 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.	您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的账户可用额度小于0，请先充值后再尝试购买。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	调用商品服务返回失败。
400	RegionDissolvedEOM	Dear 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.	客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您购买的模块不合法，请重新购买。
400	RegionEndTimeDissolvedIndia	Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.	客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400	Price.CommoditySys	Commodity system call exception.	商品系统调用异常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	您选购的周期有问题，请重新选购。
400	pay.noCreditCard	Account not bound to credit card.	账户未绑定信用卡。
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	您选购的服务存在未支付订单，请支付或作废后再下单。
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	您的基本信息未完善，请在操作前先完善您的基本信息。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的账户出现异常，详情请联系客服。
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	您的信息不完整，请在操作前填写您的信息。
400	System.SaleValidateFailed	Sales expression validation system error.	销售表达式校验系统错误。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	实例当前存在未支付订单，请支付后重试。

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

变更历史

变更时间

变更内容概要

操作

2023-11-20

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
出参	OpenAPI 返回结构发生变更。

2022-06-20

新增 OpenAPI