DescribeHistoryTasks - 查询任务中心的任务信息 - 云数据库 MongoDB

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dds:DescribeHistoryTasks	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
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：等待预设时间默认为空，表示全选，如需选择多个状态请用英文逗号（,）分隔。	Succeed,Running,Waiting
InstanceId	string	否	实例 ID，用于查询对应实例的任务，默认为空，表示不限制。如需查询多个实例请用英文逗号（,）分隔，最多支持 30 个。	dds-8vb38f0e7933xxxx
TaskId	string	否	任务 ID，用于查询已知 ID 的任务。默认为空，表示不限制。如需查询多个请用英文逗号（,）分隔，最多支持 30 个。	t-0mq1yyhm3ffl2bxxxx
TaskType	string	否	任务类型，用于查询特定类型任务情况，默认为空，表示不限制，取值如下： CreateIns：创建实例 DeleteIns：删除实例 ChangeVariable：参数调整 ModifyInsConfig：配置变更 RestartIns：重启实例 HaSwitch：实例主备切换 CloneIns：克隆实例 KernelVersionUpgrade：内核版本升级 ProxyVersionUpgrade：代理版本升级 ModifyAccount：账号变更 ModifyInsSpec：规格变更或迁移 CreateReadIns：创建只读实例 StartIns：启动实例 StopIns：暂停实例 ModifyNetwork：网络变更 LockIns：锁定实例 UnlockIns：解锁实例 DiskOnlineExpansion：磁盘在线扩容 StorageOnlineExpansion：存储在线扩容 AddInsNode：增加节点 DeleteInsNode：删除节点 ManualBackupIns：手动备份实例 ModifyInsStorageType：修改存储类型	DeleteInsNode
FromStartTime	string	是	运维任务开始的时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间），最早支持查询 30 天前的数据。	2023-03-15T03:41:26Z
ToStartTime	string	是	运维任务结束的时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间），最早支持查询 30 天前的数据。	2023-03-16T07:21:31Z
FromExecTime	integer	否	任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认 0，表示不限制。	0
ToExecTime	integer	否	任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认 0，表示不限制。	0

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	当前显示的页码。	1
RequestId	string	请求 ID。	3C4A2494-XXXX-XXXX-93CF-548DB3375193
PageSize	integer	每页显示的最大记录数。	10
TotalCount	integer	不考虑分页因素，满足查询条件的总任务数。	5
Items	array<object>	任务对象列表。
	object	任务对象，格式是词典。
Status	integer	任务状态。 Scheduled：等待执行 Running：执行中 Succeed：执行成功 Failed：执行失败 Cancelling：正在终止 Canceled：已终止 Waiting：等待预设时间	Succeed
TaskId	string	任务 ID。	t-0mq1yyhm3ffl2bxxxx
CurrentStepName	string	当前执行的步骤名，如果为空代表任务未开始。	exec_task
StartTime	string	任务开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2023-02-11T02:33Z
EndTime	string	任务结束时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2023-03-16T02:59Z
TaskType	string	任务类型。 CreateIns：创建实例 DeleteIns：删除实例 ChangeVariable：参数调整 ModifyInsConfig：配置变更 RestartIns：重启实例 HaSwitch：实例主备切换 CloneIns：克隆实例 KernelVersionUpgrade：内核版本升级 ProxyVersionUpgrade：代理版本升级 ModifyAccount：账号变更 ModifyInsSpec：规格变更或迁移 CreateReadIns：创建只读实例 StartIns：启动实例 StopIns：暂停实例 ModifyNetwork：网络变更 LockIns：锁定实例 UnlockIns：解锁实例 DiskOnlineExpansion：磁盘在线扩容 StorageOnlineExpansion：存储在线扩容 AddInsNode：增加节点 DeleteInsNode：删除节点 ManualBackupIns：手动备份实例 ModifyInsStorageType：修改存储类型	CreateIns
RemainTime	integer	预估剩余执行时间，单位秒，0 表示已执行完成。	1000
Progress	float	当前进度，范围为[0,100]。	100.0
RegionId	string	地域 ID。	cn-hangzhou
InstanceType	string	实例类型，固定为 Instance。	Instance
InstanceId	string	实例 ID。	dds-t4n18194768fxxxx
InstanceName	string	实例名称。	test-dds
DbType	string	DB 类型，固定为 mongodb。	mongodb
Product	string	产品，固定为 dds。	dds
TaskDetail	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	请求来源 System：系统 User：用户。	System
CallerUid	string	请求用户 ID，callerSource 为 User 时代表用户 UID。	141345906006****

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "3C4A2494-XXXX-XXXX-93CF-548DB3375193",
  "PageSize": 10,
  "TotalCount": 5,
  "Items": [
    {
      "Status": 0,
      "TaskId": "t-0mq1yyhm3ffl2bxxxx",
      "CurrentStepName": "exec_task",
      "StartTime": "2023-02-11T02:33Z",
      "EndTime": "2023-03-16T02:59Z",
      "TaskType": "CreateIns",
      "RemainTime": 1000,
      "Progress": 100,
      "RegionId": "cn-hangzhou",
      "InstanceType": "Instance",
      "InstanceId": "dds-t4n18194768fxxxx",
      "InstanceName": "test-dds",
      "DbType": "mongodb",
      "Product": "dds",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "ReasonCode": "小版本升级",
      "ActionInfo": "`{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}`",
      "Uid": "141345906006****",
      "CallerSource": "System",
      "CallerUid": "141345906006****"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time

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