SubmitTraceAbJob-阿里云帮助中心

Submits a job to generate A/B stream variants of a video for forensic watermarking.

Operation description

This operation supports only videos that are three minutes or longer. Submitting a job for a shorter video may cause the API call to fail or produce no output.
This is an asynchronous interface. After you submit a job, the system returns a job ID and processes the job asynchronously. You can obtain the processing result through a callback or by querying the list of A/B stream forensic watermarking jobs.

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

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Input	object	Yes	The input video for the A/B stream forensic watermarking job. Note The Object Storage Service (OSS) file or media asset must be in the same region where Intelligent Media Services (IMS) is deployed. This operation supports only videos that are three minutes or longer. Using a shorter video may cause the API call to fail or produce no output.
Type	string	Yes	The type of the input file. Valid values: `OSS`: The file is specified by an OSS URL. `Media`: The file is specified by a media asset ID.	OSS
Media	string	Yes	The location of the input file. This can be an OSS URL or a media asset ID. The supported OSS URL formats are: 1. `oss://<bucket>/<object>` 2. `http(s)://<bucket>.oss-[regionId].aliyuncs.com/<object>` In these formats, `<bucket>` is the name of the OSS bucket, which must be in the same region as your project, and `<object>` is the path to the file.	oss://bucket/object
Output	object	Yes	The output location for the A/B stream job. This must be an OSS directory.
Type	string	Yes	The type of the output object. Valid values: `OSS`: An OSS object. `Media`: A media asset ID.	OSS
Media	string	Yes	The output path. Specify an OSS directory URL or a media asset ID. If you specify an OSS URL, use one of the following formats for the output directory: 1. `oss://<bucket>/<dir>/` 2. `http(s)://<bucket>.oss-[regionId].aliyuncs.com/<dir>/` In these formats, `<bucket>` is the name of the OSS bucket, which must be in the same region as your project, and `<dir>` is the output directory path.	oss://bucket/dir/
StartTime	integer	No	The start time for watermark embedding, in seconds.	0
TotalTime	integer	No	The total duration for watermark embedding, in seconds.	360
Level	integer	No	The watermark level, which specifies the embedding channel. Valid values: `0` (U channel), `1` (UV channels), and `2` (YUV channels).	0
UserData	string	No	User data to include in the request. 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.
Data	object	Contains the IDs for the submitted job and the output media asset.
JobId	string	The job ID.	bfb786c639894f4d80648792021e****
TraceMediaId	string	The ID of the media asset created for tracing.	bf53333264f4d80648792021e****
Message	string	The response message. A value of `ok` indicates a successful request.	ok
RequestId	string	The unique identifier for the request. If you encounter an issue, provide this ID for technical support.	****36-3C1E-4417-BDB2-1E034F****
StatusCode	integer	The HTTP status code. A value of `200` indicates success.	200

Examples

Success response

JSON format

{
  "Data": {
    "JobId": "bfb786c639894f4d80648792021e****",
    "TraceMediaId": "bf53333264f4d80648792021e****"
  },
  "Message": "ok",
  "RequestId": "******36-3C1E-4417-BDB2-1E034F******",
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.