GetTask_智能媒体管理_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
imm:GetTask
Get
Project
acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

请求参数

字段名称字段详情
ProjectNamestring

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

示例值:immtest参考取值来源:
    UpdateProject
    CreateProject
    ListProjects
TaskTypestring

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

示例值:FileCompression参考取值来源:
    ListTasks
TaskIdstring

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

示例值:FileCompression-2f157087-91df-4fda-8c3e-232407ec*****参考取值来源:
    ListTasks
RequestDefinitionboolean

是否需要返回创建任务的初始请求参数,默认值为 False。

示例值:True

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:2C5C1E0F-D8B8-4DA0-8127-EC32C771****
ProjectNamestring

项目名称。

示例值:test-project
EventIdstring

事件 ID。

示例值:2F6-1Bz99Xi93EnRpNEyLudILJm****
Statusstring

任务运行状态。取值范围如下:展开详情

示例值: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<int32>

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

示例值:100

返回示例

变更历史

变更时间变更内容概要操作
2023-05-11
新增请求参数RequestDefinition
变更返回参数
2021-12-23
变更返回参数

相关示例