SubmitTraceAbJob-阿里云帮助中心

The SubmitTraceAbJob operation submits a video tracing watermark A/B stream job.

Operation description

You can submit a video tracing watermark A/B stream job only for videos that are 3 minutes or longer. Processing shorter videos may cause the operation to fail or produce no output.
Digital watermark-related operations are currently available only in the China (Shanghai) and China (Beijing) regions.
This is an asynchronous operation. After submission, the system returns a job ID and processes the job in the background. A callback notification delivers the final result. You can also call the QueryTraceAbJob operation to query the job status.

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:SubmitTraceAbJob

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Input	string	No	The Object Storage Service (OSS) location of the input video. The region of the OSS bucket must be the same as the region where you use Media Processing Service (MPS). Note	{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"test.mp4"}
Output	string	Yes	The Object Storage Service (OSS) location for the job output. You must specify the output directory by using the `Dir` parameter.	{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Dir":"out/"}
StartTime	integer	No	The start time for embedding the watermark, in seconds.	0
TotalTime	integer	No	The total duration for embedding the watermark, in seconds.	360
Level	integer	No	The watermark level. This parameter specifies the color channels for embedding the watermark. Valid values: 0 (U channel), 1 (UV channels), and 2 (YUV channels).	2
CallBack	string	No	The URL for receiving callback notifications. Currently, only HTTP URLs are supported.	http://example.com/callback
Url	string	No	A publicly accessible URL of the video. This URL overrides the `Input` parameter.	http://www.example.com/video/test.mp4
UserData	string	No	The custom user data. The maximum length is 1,024 bytes.	123
CipherBase64ed	string	No	The Base64-encoded encryption key.	Qh6OdgIMcliQSI1fReOw****

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The ID of the request.	030E2671-806A-52AF-A93C-DA8E308603A6
Message	string	The response message.	ok
Data	object	The returned data.
JobId	string	The job ID.	bfb786c639894f4d80648792021e****
MediaId	string	The media file ID.	437bd2b516ffda105d07b12a9a82****
StatusCode	integer	The status code.	200

Examples

Success response

JSON format

{
  "RequestId": "030E2671-806A-52AF-A93C-DA8E308603A6",
  "Message": "ok",
  "Data": {
    "JobId": "bfb786c639894f4d80648792021e****",
    "MediaId": "437bd2b516ffda105d07b12a9a82****"
  },
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.