You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

DescribeTasks

最近更新时间：2024.01.31 10:22:55

首次发布时间：2022.07.01 09:24:38

我的收藏

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

说明

  • 支持查询创建、导入、导出及复制自定义镜像的任务进度，包括任务ID、状态、起止时间等。
  • 您可在云服务器控制台的“运维与监控 > 任务管理”页面查看任务IDTaskIds或资源IDResourceId，具体请参见查看导出详情。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必填示例值描述
ActionString是DescribeTasks要执行的操作，取值：DescribeTasks。
VersionString是2020-04-01接口的版本，取值：2020-04-01。

TaskIds.N

String

否

TaskIds.1=t-ybnz9qci2sahiqdl****

任务ID，单次最多支持100个任务ID。您可以在调用ExportImage、CopyImage接口等操作自定义镜像时获取。

  • 参数 - N：表示任务的序号
  • 多个任务ID之间用&分隔

ResourceId

String

否

image-ebgy1og99tfc****

资源ID。

为提高兼容性，请使用ResourceIds.N参数。

ResourceIds.N

String

否

ResourceIds.1=image-ebgy1og99tfc****&ResourceIds.2=image-opisd1og89tfc****

资源ID，单次最多支持100个资源ID。

  • 参数 - N：表示任务的序号。
  • 多个资源ID之间用&分隔。

NextToken

String

否

-

分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

MaxResults

Integer

否

20

分页查询时设置的每页行数：

  • 最大值：100
  • 默认值：20

返回数据

名称类型示例值描述
NextTokenStringbHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******本次调用返回的查询凭证值，返回为空表示该页为末页。
TasksArray of struct-任务列表，具体请参见下表“ Tasks 结构”。

Tasks 结构

名称类型示例值描述
IdStringt-ybnz9qci2sahiqdl****任务ID。
CreatedAtString2022-05-06T17:33:34+08:00任务创建时间。
UpdatedAtString2022-05-06T17:33:52+08:00任务更新时间。

EndAt

String

2022-05-06T17:33:52+08:00

任务结束时间。

如果任务未结束，则此字段为空。

ResourceIdStringimage-ebgy1og99tfct0gw****资源ID。

Type

String

ExportImage

待查询任务的类型。取值：

  • ImportImage：导入自定义镜像
  • ExportImage：导出自定义镜像
  • CreateImage：创建自定义镜像
  • CopyImage：复制自定义镜像

    说明

    复制自定义镜像为邀测功能，如需试用，请提交工单或联系客户经理申请。

ProcessInteger100任务的进度，用百分数表示，单位为%。

Status

String

Succeeded

任务的状态。取值：

  • Pending：等待执行
  • Running：运行中
  • Succeeded：成功
  • Failed：失败

请求示例

GET /?Action=DescribeTasks&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeTasks",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "NextToken": "",
        "Tasks": [
            {
                "Id": "t-ybnz9qci2sahiqdl****",
                "CreatedAt": "2022-05-06T00:01:00+08:00",
                "UpdatedAt": "2022-05-06T00:07:12+08:00",
                "EndAt": "2022-05-06T00:07:12+08:00",
                "ResourceId": "image-ybnz9qci2sahiqdl****",
                "Type": "ExportImage",
                "Process": 100,
                "Status": "Succeeded"
            }
        ]
    }
}

错误码

HttpCode错误码错误信息描述
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
400LimitExceeded.MaximumMaxResultsThe number of specified MaxResults exceeds the maximum limit.指定的MaxResults超过最大限制。
400LimitExceeded.MinimumMaxResultsThe number of specified MaxResults exceeds the minimum limit.指定的MaxResults超过最小限制。
400LimitExceeded.MaximumTaskIdsYou've reached the limit on the number of TaskIds that you can set.指定的任务ID数量超过限制。
400LimitExceeded.MaximumResourceIdsYou've reached the limit on the number of ResourceIds that you can set.指定的资源ID数量超过限制。
500InternalErrorAn internal error has occurred.内部错误，请重试。如果多次尝试失败，请提交工单。