DescribeTask - 查询异步任务

查询异步任务。

调试

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

授权信息

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

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

请求语法

GET /api/v1/tasks/{TaskId} HTTP/1.1

请求参数

名称类型必填描述示例值
TaskIdstring

任务 ID。您可以调用 DescribeTasks 查看任务 ID。

t-0004d9ctt1ii********

返回参数

名称类型描述示例值
object

BaseResponse

Dataobject

返回数据

TaskIdstring

任务 ID

t-xxxxxxxx
TaskNamestring

任务名称

test5566
TaskDescriptionstring

任务描述

empty
TaskTypestring

任务类型。UPDATE_RESOURCES: 更新资源和状态, CHECK_RULES

UPDATE_RESOURCES
TaskPrioritystring

HIGH: 高优先级,一般为用户前台触发的任务, LOW: 低优先级,一般为后台任务

HIGH
RequestIdstring

请求 ID

784076D6-BD6D-5564-9CEA-834EB11F0C62
TaskDetailstring

任务执行的详细信息

{"resourceTypes":["ACS::ECS::Instance","ACS::OSS::Bucket","ACS::OTS::Instance","ACS::NAS::FileSystem"]}
ExecutionIdstring

执行 ID,暂未使用,返回空

empty
Progressinteger

进度(0 - 10000)

100
TaskStatusstring

CREATED: 创建, RUNNING: 正在执行, COMPLETE: 任务成功完成, FAILED: 任务执行失败, EXPIRED: 任务已过期, CANCELED: 任务已被取消

RUNNING
ErrorMessagestring

任务失败的错误提示。

too many requests.
StartTimelong

开始时间,格式为 Unix 时间戳,单位为秒。

1724983927
CompleteTimelong

任务完成时间。Unix 时间戳格式,单位:秒。

1724983927
ExpireTimelong

过期时间,格式为 Unix 时间戳,单位秒。

1719026680
RequestIdstring

请求的唯一标识

14DFF801-A4E3-5136-AAB8-7D246012CD7A

示例

正常返回示例

JSON格式

{
  "Data": {
    "TaskId": "t-xxxxxxxx",
    "TaskName": "test5566",
    "TaskDescription": " empty",
    "TaskType": "UPDATE_RESOURCES",
    "TaskPriority": "HIGH",
    "RequestId": "784076D6-BD6D-5564-9CEA-834EB11F0C62",
    "TaskDetail": "{\"resourceTypes\":[\"ACS::ECS::Instance\",\"ACS::OSS::Bucket\",\"ACS::OTS::Instance\",\"ACS::NAS::FileSystem\"]}",
    "ExecutionId": " empty",
    "Progress": 100,
    "TaskStatus": "RUNNING",
    "ErrorMessage": "too many requests.",
    "StartTime": 1724983927,
    "CompleteTime": 1724983927,
    "ExpireTime": 1719026680
  },
  "RequestId": "14DFF801-A4E3-5136-AAB8-7D246012CD7A"
}

错误码

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