Queries a list of media fingerprint analysis jobs.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ice:QueryDNAJobList | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
JobIds | string | No | 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
The value of DNAResult is an array of VideoMatchInfo.
VideoMatchInfo
Parameter | Type | Description |
---|---|---|
PrimaryKey | String | The unique primary key of the file. |
GlobalSimilarity | Double | The overall similarity. |
VideoMatchSegments | Array of VideoMatchSegment | The video segments that match based on video search or video search by image. |
AudioMatchSegments | Array of AudioMatchSegment | The audio segments that match based on audio search. |
TextMatchSegments | Array of TextMatchSegment | The text segments that match based on text search. |
VideoMatchSegment or AudioMatchSegment
Parameter | 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 matching video or audio in the media fingerprint library. |
MasterEndTime | Double | The end time of the matching video or audio in the media fingerprint library. |
Similarity | Double | The similarity of the input segment against the matching segments that have similar fingerprints to the input segment in the media fingerprint library. |
TextMatchSegment
Parameter | Type | Description |
---|---|---|
Start | Double | The start time of the input segment. |
End | Double | The end time of the input segment. |
QueryText | String | The input text for text fingerprint analysis. |
MasterText | String | The text segment that has similar fingerprints to the input text in the text fingerprint library. |
Similarity | Double | The 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
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
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-05-25 | The internal configuration of the API is changed, but the call is not affected | View Change Details |