DescribeTasks - 查询异步任务列表_数据灾备中心(BDRC)-阿里云帮助中心

查询异步任务列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

bdrc:DescribeTasks

none

*全部资源

*

无

请求语法

GET /api/v1/tasks HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
TaskStatus	string	否	CREATED: 创建, RUNNING: 正在执行, COMPLETE: 任务成功完成, FAILED: 任务执行失败, EXPIRED: 任务已过期, CANCELED: 任务已被取消	RUNNING
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。有关本接口查看返回数据的设置方式，请参见上文接口说明。	cae**********699
MaxResults	integer	否	返回的最大数。取值范围：10~500。默认值：当不设置值或者设置的值小于 10，默认值为 10。当设置的值大于 500 时，默认值为 500。	10

返回参数

名称	类型	描述	示例值
	object	BaseResponse<ListResult>
Data	object	返回数据
Content	array	本次请求所返回的记录集合
	object
TaskId	string	任务 ID	t-0000e4w0u1v592zdf6s7
TaskName	string	任务名称	empty
TaskDescription	string	任务描述	empty
TaskType	string	TEST: 测试任务, UPDATE_RESOURCES: 更新资源和状态, CHECK_RULES	UPDATE_RESOURCES
TaskPriority	string	HIGH: 高优先级，一般为用户前台触发的任务, LOW: 低优先级，一般为后台任务	HIGH
RequestId	string	请求 ID	AE43C4CB-8074-5EBD-9806-8CA6D12800B1
TaskDetail	string	任务详情	{"resourceTypes":["ACS::ECS::Instance","ACS::OSS::Bucket","ACS::OTS::Instance","ACS::NAS::FileSystem"]}
ExecutionId	string	执行 ID，暂未使用，返回空	empty
Progress	integer	进度（0 - 10000）	100
TaskStatus	string	CREATED: 创建, RUNNING: 正在执行, COMPLETE: 任务成功完成, FAILED: 任务执行失败, EXPIRED: 任务已过期, CANCELED: 任务已被取消	RUNNING
ErrorMessage	string	调用失败时，返回的错误信息。	device not online
StartTime	integer	开始时间，格式为 Unix 时间戳，单位：秒。	1724983927
CompleteTime	integer	任务完成时间。Unix 时间戳格式，单位：秒。	1724983927
ExpireTime	integer	过期时间，格式为 Unix 时间戳，单位：秒。	1724983927
NextToken	string	用来表示当前调用返回读取到的位置，空代表数据已经读取完毕	f4b8c2504545a3b41af5e75147d17d12e3818a0b9b2ff9a2
MaxResults	integer	本次请求所返回的最大记录条数	10
TotalCount	integer	本次请求条件下的数据总量，此参数为可选参数，默认可不返回	100
RequestId	string	请求的唯一标识	AE43C4CB-8074-5EBD-9806-8CA6D12800B1

示例

正常返回示例

JSON格式

{
  "Data": {
    "Content": [
      {
        "TaskId": "t-0000e4w0u1v592zdf6s7",
        "TaskName": " empty",
        "TaskDescription": " empty",
        "TaskType": "UPDATE_RESOURCES",
        "TaskPriority": "HIGH",
        "RequestId": "AE43C4CB-8074-5EBD-9806-8CA6D12800B1",
        "TaskDetail": "{\"resourceTypes\":[\"ACS::ECS::Instance\",\"ACS::OSS::Bucket\",\"ACS::OTS::Instance\",\"ACS::NAS::FileSystem\"]}",
        "ExecutionId": "empty",
        "Progress": 100,
        "TaskStatus": "RUNNING",
        "ErrorMessage": "device not online",
        "StartTime": 1724983927,
        "CompleteTime": 1724983927,
        "ExpireTime": 1724983927
      }
    ],
    "NextToken": "f4b8c2504545a3b41af5e75147d17d12e3818a0b9b2ff9a2",
    "MaxResults": 10,
    "TotalCount": 100
  },
  "RequestId": "AE43C4CB-8074-5EBD-9806-8CA6D12800B1"
}

错误码

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

变更历史

更多信息，参考变更详情。