All Products
Search

This Product

    Intelligent Media Services:SubmitDNAJob

    Document Center

    Intelligent Media Services:SubmitDNAJob

    Last Updated:Mar 30, 2026

    Submits a media fingerprint analysis job.

    Operation description

    • SubmitDNAJob is an asynchronous operation. After a request is sent, the system returns a request ID and a job ID and runs the task in the background.

    • Callable only in the China (Beijing), China (Hangzhou), and China (Shanghai) regions.

    • You can submit a text fingerprint analysis job 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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Input

    object

    Yes

    The input file for media fingerprint analysis.

    Type

    string

    Yes

    The type of the input file. Valid values:

    1. OSS: Object Storage Service (OSS) object.

    2. Media: media asset.

    Media
    Media

    string

    Yes

    The input file. The file can be an OSS object or a media asset. You can specify the path of an OSS object in one of the following formats:

    1. oss://bucket/object

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

    In the preceding paths, bucket indicates an OSS bucket that resides in the same region as the current project, and object indicates the path of the object in the bucket.

    1b1b9cd148034739af413150fded****
    PipelineId

    string

    No

    The ID of the ApsaraVideo Media Processing (MPS) queue to which the media fingerprint analysis job is submitted.

    5246b8d12a62433ab77845074039****
    Config

    string

    No

    The configurations of the media fingerprint analysis job. The value is a JSON object. If you specify this parameter, the template parameters are overwritten.

    {"SaveType": "save","MediaType":"video"}
    TemplateId

    string

    No

    The template ID.

    S00000101-100060
    UserData

    string

    No

    The user-defined data. The data can be up to 128 bytes in length.

    userData
    PrimaryKey

    string

    Yes

    The primary key of the video. You must make sure that each primary key is unique.

    3ca84a39a9024f19853b21be9cf9****
    DBId

    string

    Yes

    The ID of the media fingerprint library. If you do not specify this parameter, the default media fingerprint library is used. For more information about how to create a media fingerprint library, see CreateDNADB.

    2288c6ca184c0e47098a5b665e2a12****

    The Config parameter of the media fingerprint analysis job contains the SaveType and MediaType fields.

    SaveType specifies the storage type. Valid values:

    • nosave: The fingerprints of the job input are searched but not saved to the media fingerprint library.

    • save: The fingerprints of the job input are saved to the media fingerprint library only if the fingerprints are not duplicated with content in the media fingerprint library.

    • forcesave: The fingerprints of the job input are forcibly saved to the media fingerprint library.

    • onlysave: The fingerprints of the job input are saved to the media fingerprint library but not searched.

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

    • video

    • audio

    • image

    • text

    • asr

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    25818875-5F78-4A13-BEF6-D7393642CA58
    JobId

    string

    The ID of the media fingerprint analysis job. We recommend that you save this ID for subsequent calls of other 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.