SubmitTraceM3u8Job

Updated at:

Submits a video tracing watermark M3U8 job.

Operation description

  • Before invoking this operation, invoke the operation for committing a video tracing watermark AB stream to obtain the media ID of the processed AB stream, and then invoke this operation.

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

  • This operation is an asynchronous operation. After a node is committed, a node ID is returned. The node is not completed immediately but is queued and executed asynchronously in the background. The final result is notified through a callback. You can also invoke the Query a video tracing watermark M3U8 job operation to query the node status.

  • The signature authentication for the M3U8 file generated by the video tracing watermark M3U8 job is valid for 24 hours starting from the completion of the job. Query the result promptly. After the signature authentication expires, the watermark information of the job cannot be queried. To obtain the watermark information after expiration, recommit the video tracing watermark M3U8 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

mts:SubmitTraceM3u8Job

none

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

MediaId

string

Yes

The media ID of the processed AB stream. You can obtain it from the response parameters of the operation for submitting a video tracing watermark AB stream.

437bd2b516ffda105d07b12a9a82****

Output

string

Yes

The OSS output URL for the M3U8 file.

Note

The region of the OSS bucket must be the same as the region of the current MPS service.

{"Bucket":"exampleBucket","Location":"oss-cn-shanghai","Object":"out.m3u8"}

Trace

string

Yes

The tracing watermark information.

Today Monday

KeyUri

string

No

The URI of the key server.

https://cipher.abc.com

Params

string

No

The watermark job parameters, in JSON string format. The following parameters are supported:

  • m3u8Type: the algorithm type. Default value: v1.

    • v1: generates an M3U8 file with absolute paths, which can be played directly. The signature authentication is valid for 24 hours. After it expires, you must resubmit the job to obtain the M3U8 file.

    • v2: generates an M3U8 file with relative paths, which must be placed in the same path as the TS files.

{"m3u8Type":"v1"}

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

DEB915C5-D001-5C17-AF65-FF8A65DFE432

Data

object

The response data.

JobId

string

The job ID.

bfb786c639894f4d80648792021e****

Message

string

The response message.

ok

Examples

Success response

JSON format

{
  "RequestId": "DEB915C5-D001-5C17-AF65-FF8A65DFE432",
  "Data": {
    "JobId": "bfb786c639894f4d80648792021e****"
  },
  "Message": "ok"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.