你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
任务
任务是对资产执行的单个操作,它在作业中定义。
本主题提供 Task
实体的概述,并且还演示如何使用 Media Services REST API 执行各种操作。
重要
访问媒体服务中的实体时,必须在 HTTP 请求中设置特定标头字段和值。
有关详细信息,请参阅 设置媒体服务 REST API 开发 和使用 媒体服务 REST API 连接到媒体服务。
Task 实体属性
属性 | 类型 | 说明 |
---|---|---|
Id 只读。 由媒体服务在创建时设置。 |
Edm.String | 唯一标识符。 |
Configuration 可选。 |
Edm.String | 预设,定义任务将执行的处理操作(如编码、保护等)。 最大长度为 100000。 |
EndTime 只读。 由 Media Services 设置。 |
Edm.DateTime | 任务完成、失败或被取消时的日期时间。 |
ErrorDetails 只读。 由 Media Services 设置。 |
收集 (ErrorDetail) | 代码和详细消息的集合,这些消息描述在任务运行时发生的任何错误。 |
HistoricalEvents 只读。 由 Media Services 设置。 |
集合 (TaskHistoricalEvent) | 描述与任务执行关联的事件的 TaskHistoricalEvent 对象的集合。 |
MediaProcessorId 必需。 |
Edm.String | 将用在任务中的 MediaProcessor 的 ID。 可以通过在 /API/MediaProcessors 上执行 GET 请求来检索有效值。 |
Name 可选。 |
Edm.String | 可选。 任务的友好名称。 最大长度为 4000。 |
PerfMessage 只读。 由 Media Services 设置。 |
Edm.String | 包含有关任务的性能信息。 |
Priority 可选。 |
Edm.Int32 | 任务的优先级。 值越大指示相对其他任务的优先级就越高。 . 例如,优先级 = 40 的任务将在优先级为 30 的任务之前进行处理。 上限等于 MaxInt。 |
Progress 只读。 由 Media Services 设置。 |
Edm.Double | 指示 0 到 100% 的值。 |
RunningDuration 只读。 由 Media Services 设置。 |
Edm.Double | 任务的用时(以秒为单位)。 |
StartTime 只读。 由 Media Services 设置。 |
Edm.DateTime | 任务开始时的日期时间。 |
State 只读。 由 Media Services 设置。 |
Edm.Int32 | 任务的状态。 有效值为: - None = 0 - 活动 = 1 - 运行 = 2 - Completed = 3 |
TaskBody 必需。 |
Edm.String | XML 文档,其中包含有关任务应针对哪些输入和输出资产运行的信息。 一个任务必须至少有 1 个输入资产和 1 个输出资产。 该 XML 文档的格式如下。 <taskBody> <inputAsset> JobInputAsset(0)</inputAsset> <inputAsset> JobInputAsset(1)</inputAsset> <outputAsset assetCreationOptions=”1” assetName=”output” storageAccountName=”mystoreagename”> JobOutputAsset(0) </outputAsset> <taskBody> <outputAsset> 元素可以具有以下属性: - assetCreationOptions (或 AssetCreationOptions) 。 此属性可以具有以下值之一:None=0x0、StorageEncrypted=0x1、CommonEncryptionProtected=0x2、EnvelopeEncryptionProtected=0x4。 默认值为 StorageEncrypted。 - assetName (或 AssetName) 。 如果未指定,媒体服务将按以下格式设置名称:作业名称 (后缀的父 outputAsset 元素或作业 ID(如果作业名称为空)。 - storageAccountName (或 StorageAccountName) 。 输出资产将驻留的存储帐户的名称。 如果未指定,则使用用户的默认存储帐户。 一个任务可以依赖于多个任务,也可以有多个依赖项。 例如,如果任务 A 具有由<任务 B 引用为 <inputAsset 的 outputAsset>>,则任务 B 依赖于任务 A。因此,媒体服务必须先完成任务 A 的处理,然后才能处理任务 B。 |
Options 必需。 在创建后为只读。 |
Edm.Int32 | 一个枚举值,描述可用于创建任务的加密选项。 有效值为: - None = 0 - ProtectedConfiguration = 1 |
EncryptionKeyId 可选。 |
Edm.String | 已加密的密钥 ID。 |
EncryptionScheme 可选。 |
Edm.String | 与配置文件一起使用的 EncryptionScheme。 有效值为“ConfigurationEncryption”。 |
EncryptionVersion 可选。 |
Edm.String | 要使用的配置加密的版本。 当前支持的版本为“1.0”。 |
InitializationVector 可选。 |
Edm.String | 配置文件的 InitializationVector。 最大长度为 4000。 |
OutputMediaAssets 只读。 由 Media Services 设置。 |
资产 实体集 | 导航属性,可通过按 ID 值引用特定任务进行访问。 返回的实体集包含已链接到指定任务的所有 OutputMediaAsset 实体。 |
InputMediaAssets 只读。 由 Media Services 设置。 |
资产 实体集 | 导航属性,可通过按 ID 值引用特定任务进行访问。 返回的实体集包含已链接到指定任务的所有 InputMediaAsset 实体。 |
TaskNotificationSubscriptions 必需。 |
TaskNotificationSubscription 实体集 | 定义通知终结点任务状态更改。 此外, 指示是否包括要通知的任务进度。 |
创建任务
任务通过创建作业来创建。 有关示例,请参阅如何使用 Media Encoder Standard 对资产进行编码。
列出任务
任务使用 GET HTTP 请求进行检索。
方法 | 请求 URI | HTTP 版本 |
---|---|---|
GET | https://< accountname.restv2>。<location.media.azure.net/api/Tasks> | HTTP/1.1 |
方法 | 请求 URI | HTTP 版本 |
---|---|---|
GET | https://< accountname.restv2>。<location.media.azure.net/api/Jobs ('jobid>') /Tasks | HTTP/1.1 |
示例请求
若要获取最新的 x-ms-version:
,请参阅 媒体服务 REST。
GET https://<accountname>.restv2.<location>.media.azure.net/api/Jobs('nb:jid:UUID:b1f956b3-774c-bb44-a3f7-ee47e23add31')/Tasks HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net
另请参阅
AccessPolicy
资产
ContentKey
作业
作业
作业模板
定位
MediaProcessor
任务模板
配额和限制