All Products
Search
Document Center

Intelligent Media Services:QueryDNAJobList

Last Updated:Dec 27, 2024

Queries a list of media fingerprint analysis jobs.

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:QueryDNAJobList
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdsstringNo

The IDs of the media fingerprint analysis jobs that you want to query. We recommend that you query at most 10 jobs at a time. Separate multiple job IDs with commas (,).

88c6ca184c0e47098a5b665e2a12****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

25818875-5F78-4A13-BEF6-D7393642CA58
JobListarray<object>

The queried media fingerprint analysis jobs.

DNAJobobject

The queried media fingerprint analysis job.

DNAResultstring

The URL of the media fingerprint analysis result.

http://test_bucket.oss-cn-shanghai.aliyuncs.com/fingerprint/video/search_result/5/5.txt
PrimaryKeystring

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

3ca84a39a9024f19853b21be9cf9****
DBIdstring

The ID of the media fingerprint library.

2288c6ca184c0e47098a5b665e2a12****
CreationTimestring

The time when the job was created.

2022-12-28T03:21:37Z
FinishTimestring

The time when the job was complete.

2022-12-28T03:21:44Z
Statusstring

The job state. Valid values:

  • Queuing: The job is waiting in the queue.
  • Analysing: The job is in progress.
  • Success: The job is successful.
  • Fail: The job failed.
Queuing
Messagestring

The returned message.

"The resource operated \"a887d0b***d805ef6f7f6786302\" cannot be found"
Configstring

The configurations of the media fingerprint analysis job.

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

The user-defined data.

testdna
Codestring

The response code.

"InvalidParameter.ResourceNotFound"
Inputobject

The details of the input file.

Typestring

The type of the input file. Valid values:

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

The input file. The file can be an OSS object or a media asset. The path of an OSS object can be 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****
Idstring

The job ID.

88c6ca184c0e47098a5b665e2a12****

The value of DNAResult is an array of VideoMatchInfo.

VideoMatchInfo

ParameterTypeDescription
PrimaryKeyStringThe unique primary key of the file.
GlobalSimilarityDoubleThe overall similarity.
VideoMatchSegmentsArray of VideoMatchSegmentThe video segments that match based on video search or video search by image.
AudioMatchSegmentsArray of AudioMatchSegmentThe audio segments that match based on audio search.
TextMatchSegmentsArray of TextMatchSegmentThe text segments that match based on text search.

VideoMatchSegment or AudioMatchSegment

ParameterTypeDescription
StartTimeDoubleThe start time of the input video or audio.
EndTimeDoubleThe end time of the input video or audio.
MasterStartTimeDoubleThe start time of the matching video or audio in the media fingerprint library.
MasterEndTimeDoubleThe end time of the matching video or audio in the media fingerprint library.
SimilarityDoubleThe similarity of the input segment against the matching segments that have similar fingerprints to the input segment in the media fingerprint library.

TextMatchSegment

ParameterTypeDescription
StartDoubleThe start time of the input segment.
EndDoubleThe end time of the input segment.
QueryTextStringThe input text for text fingerprint analysis.
MasterTextStringThe text segment that has similar fingerprints to the input text in the text fingerprint library.
SimilarityDoubleThe similarity of the input segment against the matching segments that have similar fingerprints to the input segment in the media fingerprint library.

Examples

Sample success responses

JSONformat

{
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "JobList": [
    {
      "DNAResult": "http://test_bucket.oss-cn-shanghai.aliyuncs.com/fingerprint/video/search_result/5/5.txt",
      "PrimaryKey": "3ca84a39a9024f19853b21be9cf9****",
      "DBId": "2288c6ca184c0e47098a5b665e2a12****",
      "CreationTime": "2022-12-28T03:21:37Z",
      "FinishTime": "2022-12-28T03:21:44Z",
      "Status": "Queuing",
      "Message": "\"The resource operated \\\"a887d0b***d805ef6f7f6786302\\\" cannot be found\"",
      "Config": "{\"SaveType\": \"save\",\"MediaType\"\":\"video\"}",
      "UserData": "testdna",
      "Code": "\"InvalidParameter.ResourceNotFound\"",
      "Input": {
        "Type": "Media",
        "Media": "1b1b9cd148034739af413150fded****"
      },
      "Id": "88c6ca184c0e47098a5b665e2a12****"
    }
  ]
}

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