SubmitCopyrightExtractJob
Submits a copyright watermark extraction job.
Operation description
Currently, digital watermarking-related API operations are only supported in the China (Shanghai) and China (Beijing) regions.
This is an asynchronous API operation. After you submit a node, a node ID is returned. The node is not completed at this time and is queued to execute asynchronously in the background. The final result is sent through a callback notification. You can also call the Query copyright watermark extraction jobs operation to query the node status.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
mts:SubmitCopyrightExtractJob |
none |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Input |
string |
No |
The input Object Storage Service (OSS) URL of the file from which the copyright watermark is to be extracted. |
{"Bucket":"example","Location":"oss-cn-shanghai","Object":"example.mp4"} |
| CallBack |
string |
No |
The callback URL for the node result. Only HTTP URLs are supported. |
http://example.com/callback |
| Url |
string |
No |
The video URL that supports public network access. If you specify this parameter, it is preferentially used as the node input. Otherwise, the Input parameter is used. |
http://www.example.com/video/test.mp4 |
| UserData |
string |
No |
The custom user data. The maximum length is 1,024 bytes. |
123 |
| Params |
string |
No |
The watermark job parameters in JSON string format. The following parameters are supported:
|
{"algoType":"v1"} |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
05F8B913-E9F3-4A6F-9922-48CADA0FFAAD |
| Message |
string |
The returned message. |
ok |
| Data |
object |
The returned data. |
|
| JobId |
string |
The job ID. |
ebbfe90c63b54ed4b61acb2f6c44**** |
| StatusCode |
integer |
The status code. |
200 |
Examples
Success response
JSON format
{
"RequestId": "05F8B913-E9F3-4A6F-9922-48CADA0FFAAD",
"Message": "ok",
"Data": {
"JobId": "ebbfe90c63b54ed4b61acb2f6c44****"
},
"StatusCode": 200
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.