全部产品
Search

搜索本产品

    云服务器 ECS：DescribeTasks - 查询任务列表

    文档中心

    云服务器 ECS：DescribeTasks - 查询任务列表

    更新时间：Dec 17, 2024

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    PageNumberinteger否

    查询结果的页码。

    起始值：1。

    默认值：1。

    		1
    PageSizeinteger否

    分页查询时设置的每页记录数。

    最大值：100。

    默认值：10。

    		10
    RegionIdstring是

    地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

    		cn-hangzhou
    TaskIdsstring否

    任务 ID。单次最多支持指定 100 个，ID 之间使用半角逗号（,）分隔。

    		t-bp1hvgwromzv32iq****,t-bp179lofu2pv768w****
    TaskActionstring否

    任务操作的接口名称。取值范围：

    • ImportImage：导入镜像。
    • ExportImage：导出镜像。
    • RedeployInstance：重新部署 ECS 实例。
    • ModifyDiskSpec：变更云盘类型。
    • ArchiveSnapshot ：归档快照。
    		ImportImage
    TaskStatusstring否

    任务状态。取值范围：

    • Finished：已完成。
    • Processing：运行中。
    • Failed：失败。

    默认值：无。

    说明 只支持查询状态为 Finished、Processing 和 Failed 的任务，填入其他取值将不会生效。
    		Finished
    StartTimestring否

    按创建时间查询，创建时间区间的起始点。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2020-11-23T15:10:00Z
    EndTimestring否

    按创建时间查询，创建时间区间的终止点。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2020-11-23T15:16:00Z
    ResourceIdsarray否

    资源 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****

    返回参数

    名称类型描述示例值
    object
    PageSizeinteger

    当前分页包含多少条目。

    		10
    PageNumberinteger

    分页查询的当前页码。

    		1
    RequestIdstring

    请求 ID。

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    TotalCountinteger

    返回结果的总条目数。

    		1
    RegionIdstring

    地域 ID。

    		cn-hangzhou
    TaskSetarray<object>

    任务集合。

    Taskobject
    CreationTimestring

    创建时间。

    		2020-11-24T12:50Z
    TaskStatusstring

    任务状态。

    		Finished
    FinishedTimestring

    结束时间。

    		2020-11-24T12:50Z
    SupportCancelstring

    是否支持取消任务。

    		true
    TaskIdstring

    任务 ID。

    		t-bp1hvgwromzv32iq****
    TaskActionstring

    任务名称。

    		ImportImage
    ResourceIdstring

    资源 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错误码错误信息描述
    400MissingParameterAn input parameter "RegionId" that is mandatory for processing the request is not supplied.-
    400InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域 ID 不存在。

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史