Submits a job that generates an M3U8 file containing specific trace watermark information.
Operation description
- Before you call this operation, you must call SubmitTraceAbJob to get the TraceMediaId from its response.
- This operation is supported only in the China (Shanghai) and China (Beijing) regions.
- The M3U8 file generated by this job has a signed URL with an authentication validity period of 24 hours, starting from the moment the job is completed. Once the signature expires, you will no longer be able to trace the watermark information using that specific M3U8 file. If you need to use it after expiration, you must call this API again to generate a new M3U8 file.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ice:SubmitTraceM3u8Job | none | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| TraceMediaId | string | Yes | The media ID for the trace watermark. You can obtain this from the response of the SubmitTraceAbJob operation. | 437bd2b516ffda105d07b12a9a82**** |
| Output | object | Yes | The OSS URL of the output M3U8 file. Note
The OSS bucket must reside in the same region as the service region.
| |
| Type | string | Yes | The type of the output file. Valid value:
| OSS |
| Media | string | Yes | The OSS path where the output file is saved. You can specify the path in one of the following formats: 1. oss://bucket/object 2. http(s)://bucket.oss-[regionId].aliyuncs.com/object where bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object path in OSS. | oss://bucket/object |
| Trace | string | Yes | The specific trace watermark information. | |
| KeyUri | string | No | The URI of the key server. | https://cipher.abc.com |
| Params | string | No | Additional parameters for the watermark job, provided as a JSON string. Supported parameter:
| {"m3u8Type":"v1"} |
Response parameters
Examples
Sample success responses
JSONformat
{
"Data": {
"JobId": "bfb786c639894f4d8064879202****"
},
"Message": "ok",
"RequestId": "******11-DB8D-4A9A-875B-275798******"
}Error codes
For a list of error codes, visit the Service error codes.