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

Queries DNA jobs.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	No	The IDs of the DNA jobs to query. You can query up to 10 job IDs at a time. Separate multiple IDs with commas (,).	88c6ca184c0e47098a5b665e2a12****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	25818875-5F78-4A13-BEF6-D7393642CA58
JobList	array<object>	The DNA job information.
	array<object>	DNAJob
DNAResult	string	The URL of the DNA result.	http://test_bucket.oss-cn-shanghai.aliyuncs.com/fingerprint/video/search_result/5/5.txt
PrimaryKey	string	The unique primary key of the video. You must ensure the uniqueness of the primary key.	3ca84a39a9024f19853b21be9cf9****
DBId	string	The ID of the DNA library.	2288c6ca184c0e47098a5b665e2a12****
CreationTime	string	The time when the job was created. The time follows the ISO 8601 standard and is displayed in UTC (ending with Z).	2022-12-28T03:21:37Z
FinishTime	string	The time when the job was completed. The time follows the ISO 8601 standard and is displayed in UTC (ending with Z).	2022-12-28T03:21:44Z
Status	string	The status of the job. Valid values: Queuing: The job is queued. Analysing: The job is being analyzed. Success: The job succeeded. Fail: The job failed.	Queuing
Message	string	The error message returned for the job execution.	"The resource operated \"a887d0b***d805ef6f7f6786302\" cannot be found"
Config	string	The DNA configuration.	{"SaveType": "save","MediaType"":"video"}
UserData	string	The custom user data.	testdna
Code	string	The error code returned for the job execution.	"InvalidParameter.ResourceNotFound"
Input	object	The input file.
Type	string	The type of the input file. Valid values: OSS: the URL of an OSS object. Media: the ID of a media asset.	Media
Media	string	The information about the input file. Both OSS URLs and media asset IDs are supported. An OSS URL must be in one of the following formats: oss://bucket/object http(s)://bucket.oss-[regionId].aliyuncs.com/object In the formats, 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****
Id	string	The job ID.	88c6ca184c0e47098a5b665e2a12****

The DNAResult parameter contains an array of VideoMatchInfo objects:

VideoMatchInfo details

Name	Type	Description
PrimaryKey	String	The unique primary key of the matched file.
GlobalSimilarity	Double	The overall similarity.
VideoMatchSegments	Array of VideoMatchSegment	The information about the matched video segments in video-to-video or image-to-video search.
AudioMatchSegments	Array of AudioMatchSegment	The information about the matched audio segments in audio-to-audio search.
TextMatchSegments	Array of TextMatchSegment	The information about the matched text segments in text-to-text search.

VideoMatchSegment/AudioMatchSegment details

Name	Type	Description
StartTime	Double	The start time of the input video or audio.
EndTime	Double	The end time of the input video or audio.
MasterStartTime	Double	The start time of the video or audio in the library.
MasterEndTime	Double	The end time of the video or audio in the library.
Similarity	Double	The confidence score of the matched segment.

TextMatchSegment details

Name	Type	Description
Start	Double	The start time of the matched query segment.
End	Double	The end time of the matched query segment.
QueryText	String	The matched text segment in the query.
MasterText	String	The matched text segment in the library.
Similarity	Double	The confidence score of the matched segment.

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.