DocsICP FilingConsole
官方文档
首页

SubmitCopyrightJob

更新时间：
复制 MD 格式
产品详情
我的收藏

Submits a video copyright watermark job.

Operation description

  • By default, this operation supports only videos 3 minutes or longer. Submitting a job for a shorter video may fail or produce no output. To watermark shorter videos, use the Params parameter.

  • You can submit a watermark job for only one video per API call.

  • Currently, digital watermark-related APIs are available only in the China (Shanghai) and China (Beijing) regions.

  • This is an asynchronous interface. After you submit a job, the system returns a job ID and queues the job for background processing. Results are delivered via callback notification. Alternatively, you can call the Query Video Copyright Job List operation to check the job status.

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

none

*All Resource

*

 None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
Input

object

Yes

The input video file to be watermarked.

Note

  • The OSS object or media asset must be in the same region as the service call.

{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.mp4"}
Type

string

Yes

The type of the input file. Valid values:

  1. OSS: The URL of an OSS object.

  2. Media: The media asset ID.

OSS
Media

string

Yes

The input file, specified as either an OSS URL or a media asset ID. The following formats are supported for OSS URLs:

1. oss://bucket/object

2. http(s)://bucket.oss-[regionId].aliyuncs.com/object

In these formats, bucket specifies the name of an OSS bucket in the same region as the service, and object specifies the file path.

oss://bucket/object
Output

object

Yes

The location of the output file.

Note

  • The OSS bucket must be in the same region as the service call.

{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example_result.mp4"}
Type

string

Yes

The type of the output file. Valid value:

  1. OSS: The URL of an OSS object.

OSS
Media

string

Yes

The OSS URL for the output file. The following formats are supported:

1. oss://bucket/object

2. http(s)://bucket.oss-[regionId].aliyuncs.com/object
In these formats, bucket specifies the name of an OSS bucket in the same region as the service, and object specifies the file path.

oss://test-bucket/output.mp4
Message

string

Yes

The watermark content to embed.

版权水印测试
StartTime

integer

No

The start time of the watermark in seconds. Defaults to 0.

0
TotalTime

integer

No

The end time of the watermark in seconds. If unspecified, the watermark is applied until the video ends.

10
Level

integer

No

The watermark level, which specifies the embedding channel. Valid values are 0, 1, and 2, which correspond to the U, UV, and YUV channels, respectively.

0
Description

string

No

A description of the watermark job.

任务描述
UserData

string

No

The user data. The value can be up to 1,024 bytes in length.

123
Params

string

No

The parameters for the watermark job, specified as a JSON string. The following parameter is supported:

  • algoType: The algorithm type. Defaults to v1.

    • v1: For videos 3 minutes or longer.

    • v2: For short videos.

{"algoType":"v2"}

Response elements

Element

Type

Description

Example

object

Data

object

The returned data.

JobId

string

The job ID.

bfb786c63****f4d80648792021eff90
Message

string

The response message.

ok
RequestId

string

The request ID.

FA258E67-09B8-4EAA-8F33-BA567834A2C3

StatusCode

integer

The status code.

200

Examples

Success response

JSON format

{
  "Data": {
    "JobId": "bfb786c63****f4d80648792021eff90"
  },
  "Message": "ok",
  "RequestId": "FA258E67-09B8-4EAA-8F33-BA567834A2C3\n",
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.