All Products
Search

This Product

    Intelligent Media Services:SubmitDNAJob

    Document Center

    Intelligent Media Services:SubmitDNAJob

    Last Updated:Dec 16, 2024

    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.
    • You can call this operation 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.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ice:SubmitDNAJob
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InputobjectYes

    The input file for media fingerprint analysis.

    TypestringYes

    The type of the input file. Valid values:

    1. OSS: Object Storage Service (OSS) object.
    2. Media: media asset.
    		Media
    MediastringYes

    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****
    PipelineIdstringNo

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

    		5246b8d12a62433ab77845074039****
    ConfigstringNo

    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"}
    TemplateIdstringNo

    The template ID.

    		S00000101-100060
    UserDatastringNo

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

    		userData
    PrimaryKeystringYes

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

    		3ca84a39a9024f19853b21be9cf9****
    DBIdstringYes

    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 parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

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

    The ID of the media fingerprint analysis job. We recommend that you save this ID for subsequent calls of other operations.

    		88c6ca184c0e47098a5b665e2****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-05-25The internal configuration of the API is changed, but the call is not affectedView Change Details