使用DescribeTasks查询异步任务状态与进度-云服务器 ECS-阿里云-云服务器 ECS(ECS)-阿里云帮助中心

调用DescribeTasks查询一个或多个异步请求的进度。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecs:DescribeTasks

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	查询结果的页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页查询时设置的每页记录数。最大值：100。默认值：10。	10
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
TaskIds	string	否	任务 ID。单次最多支持指定 100 个，ID 之间使用半角逗号（,）分隔。	t-bp1hvgwromzv32iq**,t-bp179lofu2pv768w**
TaskAction	string	否	任务操作的接口名称。取值范围： ImportImage：导入镜像。 ExportImage：导出镜像。 RedeployInstance：重新部署 ECS 实例。 ModifyDiskSpec：变更云盘类型。 ArchiveSnapshot ：归档快照。	ImportImage
TaskStatus	string	否	任务状态。取值范围： Finished：已完成。 Processing：运行中。 Failed：失败。默认值：无。说明只支持查询状态为 Finished、Processing 和 Failed 的任务，填入其他取值将不会生效。	Finished
StartTime	string	否	按创建时间查询，创建时间区间的起始点。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2020-11-23T15:10:00Z
EndTime	string	否	按创建时间查询，创建时间区间的终止点。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2020-11-23T15:16:00Z
ResourceIds	array	否	资源 ID。N 的取值范围：1~100。
	string	否	任务关联的资源 ID。N 的取值范围：1~100。当 TaskAction 为 ImportImage、ExportImage 时，资源 ID 为镜像 ID。当 TaskAction 为 RedeployInstance 时，资源 ID 为 ECS 实例 ID。当 TaskAction 为 ModifyDiskSpec 时，资源 ID 为磁盘 ID。	m-bp1i8huqm5u7****
TaskGroupId	string	否	任务组 ID。说明该参数正在邀测中，当使用该参数时，其它查询条件将失效。	g-2ze2op2grqpclwu7****

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	当前分页包含多少条目。	10
PageNumber	integer	分页查询的当前页码。	1
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返回结果的总条目数。	1
RegionId	string	地域 ID。	cn-hangzhou
TaskSet	object
Task	array<object>	任务集合。
	object
CreationTime	string	创建时间。格式为 ISO 8601，时区为 UTC。	2020-11-24T12:50Z
TaskStatus	string	任务状态。	Finished
FinishedTime	string	结束时间。格式为 ISO 8601，时区为 UTC。	2020-11-24T12:50Z
SupportCancel	string	是否支持取消任务。	true
TaskId	string	任务 ID。	t-bp1hvgwromzv32iq****
TaskAction	string	任务名称。	ImportImage
ResourceId	string	资源 ID。	m-bp1i8huqm5u7****

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "RegionId": "cn-hangzhou",
  "TaskSet": {
    "Task": [
      {
        "CreationTime": "2020-11-24T12:50Z",
        "TaskStatus": "Finished",
        "FinishedTime": "2020-11-24T12:50Z",
        "SupportCancel": "true",
        "TaskId": "t-bp1hvgwromzv32iq****",
        "TaskAction": "ImportImage",
        "ResourceId": "m-bp1i8huqm5u7****"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParameter	An input parameter "RegionId" that is mandatory for processing the request is not supplied.
400	InvalidRegionId.NotFound	The specified RegionId does not exist.

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

变更历史

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