QueryCopyrightJobList-阿里云帮助中心

Queries copyright watermarking jobs.

Operation description

This operation is supported only in the China (Shanghai) and China (Beijing) regions.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CreateTimeStart	integer	No	The start of the creation time range for the query, in UNIX timestamp format.	1627357322
CreateTimeEnd	integer	No	The end of the creation time range for the query, in UNIX timestamp format.	1627357325
JobId	string	No	The job ID.	**cdb3e74639973036bc84**
Level	integer	No	The watermark level, indicating the color channel for embedding. 0: U. 1: UV. 2: YUV.	0
PageNumber	integer	No	The page number.	0
PageSize	integer	No	The number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
Data	array<object>	The data returned.
	array<object>	The data returned.
GmtCreate	integer	The creation time of the job.	1627357322
GmtModified	integer	The last modification time of the job.	1627357322
Input	object	Information about the input video for watermarking.
Type	string	The type of the input file. Valid values: OSS: an Object Storage Service (OSS) object. Media: a media asset.	OSS
Media	string	The specific input information.	oss://bucket/object
Output	object	Information about the watermarked output video.
Type	string	The type of the output file. Valid values: OSS: an OSS object. Media: a media asset.	OSS
Media	string	The specific output information.	oss://bucket/object
JobId	string	The job ID.	bfb786c639894f4d80648792021****
Level	integer	The watermark level.	2
Message	string	The content of the embedded watermark.	test
Result	string	The job result.	{"Code":"success","Message":"ok"}
Status	string	The status of the job.	success
UserData	string	The user-defined data.	123
UserId	integer	The ID of the user who initiated the job.	1346693***
Message	string	The message returned.	ok
RequestId	string	The ID of the request.	****36-3C1E-4417-BDB2-1E034F****
StatusCode	integer	The status code.	200

Examples

Success response

JSON format

{
  "Data": [
    {
      "GmtCreate": 1627357322,
      "GmtModified": 1627357322,
      "Input": {
        "Type": "OSS",
        "Media": "oss://bucket/object"
      },
      "Output": {
        "Type": "OSS",
        "Media": "oss://bucket/object"
      },
      "JobId": "bfb786c639894f4d80648792021****",
      "Level": 2,
      "Message": "test",
      "Result": "{\"Code\":\"success\",\"Message\":\"ok\"}",
      "Status": "success",
      "UserData": "123",
      "UserId": 0
    }
  ],
  "Message": "ok",
  "RequestId": "******36-3C1E-4417-BDB2-1E034F******",
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.