QueryCopyrightJob - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Queries video copyright watermark jobs.

Operation description

Currently, digital watermarking API operations are supported only in the China (Shanghai) and China (Beijing) regions.
The maximum time range for querying historical data (job information) is six months.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CreateTimeStart	integer	No	The start creation time, in the UNIX timestamp format.	1627357322
CreateTimeEnd	integer	No	The end creation time, in the UNIX timestamp format.	1627357325
JobId	string	No	The job ID.	2a0697e35a7342859f733a9190c4****
Level	integer	No	The watermark level, which indicates the embedding channel. Valid values: 0 (u channel), 1 (uv channels), and 2 (yuv channels).	2
PageNumber	integer	No	The page number.	0
PageSize	integer	No	The number of entries per page.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	5CA6E020-4102-4FFF-AA56-5ED7ECD811A1
Message	string	The response message.	ok
Data	array<object>	The response data.
	object	The response data.
Callback	string	The callback URL.	http://callbacktest.com/callback
GmtCreate	integer	The creation time.	1627357322
GmtModified	integer	The update time.	1627357328
Input	string	The input video for watermarking.	{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"gambling.mp4"}
JobId	string	The job ID.	bfb786c639894f4d80648792021e****
Level	integer	The watermark level.	2
Message	string	The watermark information.	T-Head Semiconductor(Shanghai)
Output	string	The output video with the watermark.	{"Bucket":"ivison-test","Location":"oss-cn-shanghai","Object":"out.mp4"}
Status	string	The status.	success
UserData	string	The user data.	123
UserId	integer	The user ID.	1346693***
Result	string	The task result.	{"Code":"success","Message":"ok"}
StatusCode	integer	The status code.	200

Examples

Success response

JSON format

{
  "RequestId": "5CA6E020-4102-4FFF-AA56-5ED7ECD811A1",
  "Message": "ok",
  "Data": [
    {
      "Callback": "http://callbacktest.com/callback",
      "GmtCreate": 1627357322,
      "GmtModified": 1627357328,
      "Input": "{\"Bucket\":\"ivison-test\",\"Location\":\"oss-cn-shanghai\",\"Object\":\"gambling.mp4\"}",
      "JobId": "bfb786c639894f4d80648792021e****",
      "Level": 2,
      "Message": "T-Head Semiconductor(Shanghai)",
      "Output": "{\"Bucket\":\"ivison-test\",\"Location\":\"oss-cn-shanghai\",\"Object\":\"out.mp4\"}",
      "Status": "success",
      "UserData": "123",
      "UserId": 0,
      "Result": "{\"Code\":\"success\",\"Message\":\"ok\"}"
    }
  ],
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.