DescribeTasks - 云服务器 ECS

调试

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

请求参数


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

返回数据


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

示例

请求示例

http(s)://ecs.aliyuncs.com/?Action=DescribeTasks
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&TaskIds=t-bp1hvgwromzv32iq****
&TaskAction=ImportImage
&TaskStatus=Finished
&StartTime=2020-11-23T15:10:00Z
&EndTime=2020-11-23T15:16:00Z
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeTasksResponse>
    <TotalCount>1</TotalCount>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <TaskSet>
        <Task>
            <TaskId>t-bp1hvgwromzv32iq****</TaskId>
            <TaskAction>ImportImage</TaskAction>
            <SupportCancel>true</SupportCancel>
            <CreationTime>2020-11-24T12:50Z</CreationTime>
            <TaskStatus>Finished</TaskStatus>
            <FinishedTime>2020-11-24T12:50Z</FinishedTime>
        </Task>
    </TaskSet>
    <RegionId>cn-hangzhou</RegionId>
</DescribeTasksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码


HttpCode	错误码	错误信息	描述
400	InvalidRegionId.NotFound	The specified RegionId does not exist.	指定的地域 ID 不存在。

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