SubmitTraceExtractJob-阿里云帮助中心

Operation description

The digital watermarking APIs are available only in the China (Shanghai) and China (Beijing) regions.
Trace watermark extraction is supported only for videos that are 3 minutes or longer. Jobs for shorter videos will fail.
This is an asynchronous API. After you submit a job, a job ID is returned. The job is not immediately complete and is queued for asynchronous processing. You can get the final result through a callback notification or check the job status by calling the GetTraceExtractJob 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

ice:SubmitTraceExtractJob

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Input	object	Yes	The input video from which to extract the watermark. Note The OSS object or media asset must be in the same region as your IMS service.
Type	string	Yes	The input type. Valid values: OSS: An OSS object URL. Media: A media asset ID.	OSS
Media	string	Yes	The input source. Specify an OSS object URL or a media asset ID. An OSS object URL can be in one of the following formats: 1. oss://bucket/object In these formats, `bucket` is the name of an OSS bucket in the same region as your IMS service, and `object` is the path of the OSS object.	oss://bucket/object
UserData	string	No	The user-defined data. Maximum length: 1,024 bytes.	123
Params	string	No	Extraction job parameters, specified as a JSON string. The following parameters are supported: `m3u8Type`: The algorithm type. The default value is `v1`. `v1`: Extracts an m3u8 playlist with absolute paths. `v2`: Extracts an m3u8 playlist with relative paths.	{"m3u8Type":"v1"}

Response elements

Element	Type	Description	Example
	object	The response schema.
Data	object	The data returned.
JobId	string	The job ID.	bfb786c639894f4d80648792021e****
Message	string	The response message.	ok
RequestId	string	The request ID.	**63E8B7C7-4812-46AD-0FA56029AC86**
StatusCode	integer	The status code.	200

Examples

Success response

JSON format

{
  "Data": {
    "JobId": "bfb786c639894f4d80648792021e****"
  },
  "Message": "ok",
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.