SubmitDNAJob-阿里云帮助中心

Operation description

This is an asynchronous API. After you submit a job, the system returns a job ID and queues the job for asynchronous execution in the background. You receive the final result in a callback notification. You can also call the ListDNAJobs operation to query the job status.
This operation is available in the following regions: China (Beijing), China (Hangzhou), and China (Shanghai).
Text-based DNA jobs are 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

*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 input is an OSS file url. `Media`: The input is a media ID.	Media
Media	string	Yes	The media ID or OSS file url of the input file. 1. `oss://bucket/object` 2. `http(s)://bucket.oss-[regionId].aliyuncs.com/object` In these formats, `bucket` is the name of an OSS bucket in the same region as your project, and `object` is the file path.	1b1b9cd148034739af413150fded****
PipelineId	string	No	The pipeline ID.	5246b8d12a62433ab77845074039****
Config	string	No	The DNA configuration in JSON format. If specified, these settings override the corresponding template parameters.	{"SaveType": "save","MediaType":"video"}
TemplateId	string	No	The template ID.	S00000101-100060
UserData	string	No	The user-defined data. The maximum length is 128 bytes.	userData
PrimaryKey	string	Yes	The unique primary key for the video. You are responsible for ensuring its uniqueness.	3ca84a39a9024f19853b21be9cf9****
DBId	string	Yes	The DNA library ID. To create a DNA library, see CreateDNADB.	2288c6ca184c0e47098a5b665e2a12****

The Config parameter includes the SaveType and MediaType fields.

SaveType specifies the storage policy. Valid values include:

nosave: Searches for duplicates in the DNA library but does not add the input file.
save: Adds the input file to the DNA library only if no duplicates are found.
forcesave: Adds the input file to the DNA library regardless of whether duplicates exist.
onlysave: Adds the input file to the DNA library without searching for duplicates.

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

video: Video.
audio: Audio.
image: Image.
text: Long text.
asr: ASR-recognized text.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	25818875-5F78-4A13-BEF6-D7393642CA58
JobId	string	The ID of the DNA job. Save this ID for subsequent API calls.	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.