DescribeHistoryTasksStat - 查询任务中心任务状态的概览信息_云数据库 MongoDB 版(MongoDB)-阿里云帮助中心

查看任务中心任务的概览信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	待处理事件所属的地域 ID，您可以通过调用 DescribeRegions 接口进行查询。	cn-beijing
Status	string	否	任务状态，用于选择对应状态的任务： Scheduled：等待执行 Running：执行中 Succeed：执行成功 Failed：执行失败 Cancelling：正在终止 Canceled：已终止 Waiting：等待预设时间默认为空，表示全选，如需选择多个状态请用英文逗号（,）分隔。	Succeed
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：修改存储类型	DeleteIns
FromStartTime	string	是	运维任务开始的时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间），最早支持查询 30 天前的数据。	2023-04-16T02:46:21Z
ToStartTime	string	是	运维任务结束的时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间），最早支持查询 30 天前的数据。	2023-05-16T02:15:52Z
FromExecTime	integer	否	任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认 0，表示不限制。	0
ToExecTime	integer	否	任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认 0，表示不限制。	0

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	FC724D23-XXXX-XXXX-ABB1-606C935AE7FD
Items	object []	任务对象列表。
Status	string	任务状态。 Scheduled：等待执行 Running：执行中 Succeed：执行成功 Failed：执行失败 Cancelling：正在终止 Canceled：已终止 Waiting：等待预设时间	Succeed
TotalCount	integer	任务状态对应的任务数量。	2

示例

正常返回示例

JSON格式

{
  "RequestId": "FC724D23-XXXX-XXXX-ABB1-606C935AE7FD",
  "Items": [
    {
      "Status": "Succeed",
      "TotalCount": 2
    }
  ]
}

错误码

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

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