Submits an A/B watermarking job.
Operation description
- This API supports only videos that last at least 3 minutes. If the video is too short, the call may fail, or no output may be returned.
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:SubmitTraceAbJob | none | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Input | object | Yes | The source video file for A/B watermarking. Note
OSS object or media asset must reside in the same region as the IMS service region. This API supports only videos that last at least 3 minutes. If the video is too short, the call may fail, or no output may be returned.
| |
| Type | string | Yes | The type of the source file. Valid values:
| OSS |
| Media | string | Yes | The source file. The file can be an OSS object or a media asset. You can specify the path of an OSS object 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 |
| Output | object | Yes | The output directory path. | |
| Type | string | Yes | The type of the output file. Valid values:
| OSS |
| Media | string | Yes | The output file. The file can be an OSS object or a media asset. OSS URL formats: 1. oss://bucket/dir/ 2. http(s)://bucket.oss-[regionId].aliyuncs.com/dir/ In the URL, bucket specifies an OSS bucket that resides in the same region as the job, and dir specifies the object path in OSS. | oss://bucket/dir/ |
| StartTime | string | No | The start point of watermark embedding. Unit: seconds. | 0 |
| TotalTime | string | No | The duration of the watermark embedding. Unit: seconds. | 360 |
| Level | long | No | The watermark level, which specifies the channel to embed watermarks. Valid values: 0 specifies the 0u channel, 1 specifies the 1uv channel, and 2 specifies the 2yuv channel. | 0 |
| UserData | string | No | The custom data, which can be up to 1,024 bytes in size. | 123 |
| CipherBase64ed | string | No | The key that is encoded by using the Base64 algorithm. | Qh6OdgIMcliQSI1fReOw**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"Data": {
"JobId": "bfb786c639894f4d80648792021e****",
"TraceMediaId": "bf53333264f4d80648792021e****"
},
"Message": "ok",
"RequestId": "******36-3C1E-4417-BDB2-1E034F******",
"StatusCode": 200
}Error codes
For a list of error codes, visit the Service error codes.