SubmitDNAJob-Intelligent Media Services(IMS)-阿里云帮助中心

Operation description

This operation is an asynchronous operation. After you submit a task, a task ID is returned. The task is not completed at this time and enters the background queue for asynchronous execution. The final result is notified through a callback. You can also call the List DNA jobs operation to query the task status.
This operation is currently supported in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.
Submitting text DNA jobs is currently supported only in the China (Shanghai) region.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Input	object	Yes	The input DNA file.
Type	string	Yes	The type of the input file. Valid values: OSS: the URL of an OSS file. Media: the ID of a media asset.	Media
Media	string	Yes	The information about the input file. OSS URLs and media asset IDs are supported. OSS URL formats: oss://bucket/object http(s)://bucket.oss-[regionId].aliyuncs.com/object In the URLs, bucket is the name of the OSS bucket that resides in the same region as the current project, and object is the file path.	1b1b9cd148034739af413150fded****
PipelineId	string	No	The ID of the pipeline.	5246b8d12a62433ab77845074039****
Config	string	No	The DNA configuration, which is a JSON object. If you specify this parameter, it overwrites the template parameters.	{"SaveType": "save","MediaType":"video"}
TemplateId	string	No	The ID of the template.	S00000101-100060
UserData	string	No	The custom user data. The maximum length is 128 bytes.	userData
PrimaryKey	string	Yes	The unique primary key of the video. You must ensure its uniqueness.	3ca84a39a9024f19853b21be9cf9****
DBId	string	Yes	The ID of the DNA library. To create a DNA library, see CreateDNADB - Create a DNA library.	2288c6ca184c0e47098a5b665e2a12****

The Config parameter for the DNA configuration includes the SaveType and MediaType fields.

SaveType specifies the storage type. Valid values:

nosave: searches only and does not add the file to the library.
save: deduplicates and adds the file to the library.
forcesave: forcibly adds the file to the library.
onlysave: adds the file to the library only and does not search.

MediaType specifies the media type of the input file. Valid values:

video: video.
audio: audio.
image: image.
text: long text.
asr: ASR-recognized text.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	25818875-5F78-4A13-BEF6-D7393642CA58
JobId	string	The ID of the video DNA job. Save this ID for subsequent calls to other related operations.	88c6ca184c0e47098a5b665e2****

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "JobId": "88c6ca184c0e47098a5b665e2****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.