SubmitTraceM3u8Job-阿里云帮助中心

Operation description

Before you call this operation, you must submit a job to process the video's AB stream to obtain its media ID, which is a required input for this operation.
The digital watermark feature is available only in the China (Shanghai) and China (Beijing) regions.
This is an asynchronous API. After you submit a job, the system returns a job ID and queues it for background processing. You will receive the job result through a callback notification. You can also call the Query video trace watermark m3u8 job operation to query the job's status.
The signature authentication for the M3U8 file generated by the job is valid for 24 hours after the job completes. After the signature authentication expires, you can no longer retrieve the watermark information for the job. To retrieve the information again, 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

mts:SubmitTraceM3u8Job

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaId	string	Yes	The media ID of the processed AB stream. You can obtain this ID from the response of the operation that submits the AB stream processing job.	437bd2b516ffda105d07b12a9a82****
Output	string	Yes	The OSS location of the output M3U8 file. Note The OSS bucket must be in the same region as your MPS service.	{"Bucket":"exampleBucket","Location":"oss-cn-shanghai","Object":"out.m3u8"}
Trace	string	Yes	The trace watermark information.	今天星期一
KeyUri	string	No	The key server URI.	https://cipher.abc.com
Params	string	No	The parameters for the watermark job, specified as a JSON string. The following parameters are supported: `m3u8Type`: The algorithm type. The default value is `v1`. `v1`: Generates an M3U8 file with absolute paths that can be played directly. The signature authentication is valid for 24 hours. After expiration, you must submit a new job to get a new M3U8 file. `v2`: Generates an M3U8 file with relative paths. This file must be in the same directory as the TS files.	{"m3u8Type":"v1"}

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	DEB915C5-D001-5C17-AF65-FF8A65DFE432
Data	object	The returned 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.