All Products
Search

This Product

    Intelligent Media Services:SubmitTraceM3u8Job

    Document Center

    Intelligent Media Services:SubmitTraceM3u8Job

    Last Updated:Apr 07, 2026

    Submits a job to process an M3U8 file for video watermarking for tracing.

    Operation description

    • You must first obtain a media ID by submitting a job for an A/B stream with video watermarking for tracing. This operation uses the returned media ID for processing.

    • Currently, digital watermarking-related operations are supported only in the China (Shanghai) and China (Beijing) regions.

    • This is an asynchronous call. When you submit a job, the system returns a task ID and processes the job in the background. The initial response does not mean the job is complete. You can get the final result through a callback notification or by calling the QueryTraceM3u8JobList operation to check the job's status.

    • The signature for an M3U8 file generated by a video watermarking for tracing job is valid for 24 hours after job completion. You must query and use the watermarking information within this period. If the signature expires, you can no longer retrieve the watermarking information. To regain access, you must submit a new job.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ice:SubmitTraceM3u8Job

    none

    *All Resource

    *

    		 None None

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TraceMediaId

    string

    Yes

    The media ID of the processed A/B stream for video watermarking for tracing. This ID is returned in the response when you submit the A/B stream job.

    437bd2b516ffda105d07b12a9a82****
    Output

    object

    Yes

    The OSS destination for the output M3U8 file.

    Note

    The OSS bucket must be in the same region as your MPS service.

    Type

    string

    Yes

    The type of the output destination. Valid values:

    1. OSS: an OSS file location.

    OSS
    Media

    string

    Yes

    The output file path. Only OSS paths are supported. You can use one of the following formats:

    1. oss://bucket/object

    2. http(s)://bucket.oss-[regionId].aliyuncs.com/object. In these formats, bucket specifies the name of an OSS bucket in the same region as your project, and object specifies the file path.

    oss://bucket/object
    Trace

    string

    Yes

    The watermark content to embed.

    溯源水印测试
    KeyUri

    string

    No

    The URI of the key server.

    https://cipher.abc.com
    Params

    string

    No

    A JSON string that contains parameters for the watermarking job. The following parameter is supported:

    • m3u8Type: The algorithm type. The default value is v1.

      • v1: Generates an M3U8 file that uses an absolute path. The file can be played directly. The signature is valid for 24 hours. After expiration, you must submit a new job to get a new M3U8 file.

      • v2: Generates an M3U8 file that uses a relative path. This file must be stored in the same directory as the TS files.

    {"m3u8Type":"v1"}

    Response elements

    Element

    Type

    Description

    Example

    object

    The response object.

    Data

    object

    The response data.

    JobId

    string

    The job ID.

    bfb786c639894f4d8064879202****
    Message

    string

    The response message.

    ok
    RequestId

    string

    The request ID.

    ******11-DB8D-4A9A-875B-275798******

    Examples

    Success response

    JSON format

    {
  "Data": {
    "JobId": "bfb786c639894f4d8064879202****"
  },
  "Message": "ok",
  "RequestId": "******11-DB8D-4A9A-875B-275798******"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.