SubmitTraceExtractJob-阿里云帮助中心

Operation description

Digital watermark APIs are available only in the China (Shanghai) and China (Beijing) regions.
This is an asynchronous API. After you submit a job, a job ID is returned. The job is then queued for background processing. The final result is sent via a callback. You can also check the job status by calling the Query Trace Extraction Job operation.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Input	string	No	The OSS address of the input file for trace watermark extraction.	{"Bucket":"example","Location":"oss-cn-shanghai","Object":"example.mp4"}
UserData	string	No	User-defined data. Maximum length: 1,024 bytes.	123
CallBack	string	No	The callback URL for job results. Only HTTP URLs are supported.	http://example.com/callback
Url	string	No	A publicly accessible URL of the video file. If specified, this URL is used as the job input and takes precedence over the Input parameter.	http://www.example.com/video/test.mp4
Params	string	No	Parameters for the extraction job, specified as a JSON string. The following parameter is supported: m3u8Type: The algorithm type. Default: v1. v1: Extracts an M3U8 file with an absolute path. v2: Extracts an M3U8 file with a relative path.	{"m3u8Type":"v1"}

Response elements

Element	Type	Description	Example
	object	Schema of the response
RequestId	string	The ID of the request.	A1326BD4-30B1-4CB6-Q123-3330B877B0D4
Message	string	The response message.	ok
Data	object	The data returned in the response.
JobId	string	The job ID.	bfb786c639894f4d80648792021e****
StatusCode	integer	The status code.	200

Examples

Success response

JSON format

{
  "RequestId": "A1326BD4-30B1-4CB6-Q123-3330B877B0D4",
  "Message": "ok",
  "Data": {
    "JobId": "bfb786c639894f4d80648792021e****"
  },
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.