GetTask - 获取任务信息

该接口用于主动查询指定的异步任务信息。IMM支持多种异步数据处理能力,每种能力有各自创建任务的接口,例如创建人物人脸聚类任务CreateFigureClusteringTask、创建文件压缩任务CreateFileCompressionTask等。本接口为通用接口,可以通过任务ID和类型来查询异步任务的详细信息。

接口说明

请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:GetTaskget
*Project
acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

请求参数

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

项目名称,获取方式请参见创建项目

immtest
TaskTypestring

任务的类型。取值范围请参见任务类型列表

FileCompression
TaskIdstring

需要查询的任务 ID,该值在创建任务时作为返回参数。

FileCompression-2f157087-91df-4fda-8c3e-232407ec*****
RequestDefinitionboolean

是否返回创建任务的原始请求参数,取值如下:

  • true。
  • false(默认值)。

当前该参数仅对部分任务类型生效,支持的任务类型如下:

  • MediaConvert
  • VideoLabelClassification
  • FaceClustering
  • FileCompression
  • ArchiveFileInspection
  • FileUncompression
  • PointCloudCompress
  • ImageToPDF
  • StoryCreation
  • LocationDateClustering
  • ImageSplicing
  • FacesSearching
true

返回参数

名称类型描述示例值
object

查询到指定任务的详细信息。

RequestIdstring

请求 ID。

2C5C1E0F-D8B8-4DA0-8127-EC32C771****
ProjectNamestring

项目名称。

test-project
EventIdstring

事件 ID。

2F6-1Bz99Xi93EnRpNEyLudILJm****
Statusstring

任务运行状态。取值范围如下:

  • Running:任务运行中。

  • Succeeded:任务执行完成,成功。

  • Failed:任务执行完成,失败。

Running
Codestring

任务错误码。

ResourceNotFound
Messagestring

任务错误消息。

The specified resource project is not found.
StartTimestring

任务开始时间。

2021-12-24T03:01:41.662060377Z
EndTimestring

任务结束时间。

2021-12-24T03:01:49.480109219Z
UserDatastring

用户自定义信息。

{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
TaskTypestring

任务的类型。取值范围请参见任务类型列表

FileCompression
TaskIdstring

任务 ID。

c2b277b9-0d30-4882-ad6d-ad661382****
Tagsobject

任务标签。用户在创建任务时传入的“Tag”标签。

{"test": "val1"}
TaskRequestDefinitionstring

创建任务的初始请求参数。

{ "ProjectName":"test-project", "CompressedFormat":"zip", "TargetURI":"oss://test-bucket/output/test.zip", "Sources":[{"URI":"oss://test-bucket/input/test.jpg"}] }
Progressinteger

任务进度。取值范围为 0~100,单位为百分比(%)。

说明
  • 目前 GetTask 接口暂不支持该参数。
  • 该参数仅在任务运行状态StateRunning时有意义。
  • 100

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "2C5C1E0F-D8B8-4DA0-8127-EC32C771****",
      "ProjectName": "test-project",
      "EventId": "2F6-1Bz99Xi93EnRpNEyLudILJm****",
      "Status": "Running",
      "Code": "ResourceNotFound",
      "Message": "The specified resource project is not found.",
      "StartTime": "2021-12-24T03:01:41.662060377Z",
      "EndTime": "2021-12-24T03:01:49.480109219Z",
      "UserData": {
        "ID": "user1",
        "Name": "test-user1",
        "Avatar": "http://example.com?id=user1"
      },
      "TaskType": "FileCompression",
      "TaskId": "c2b277b9-0d30-4882-ad6d-ad661382****",
      "Tags": {
        "test": "val1"
      },
      "TaskRequestDefinition": {
        "ProjectName": "test-project",
        "CompressedFormat": "zip",
        "TargetURI": "oss://test-bucket/output/test.zip",
        "Sources": [
          {
            "URI": "oss://test-bucket/input/test.jpg"
          }
        ]
      },
      "Progress": 100
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-05-11OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情