Queries media fingerprint analysis jobs. You can call this operation to query video fingerprint analysis jobs and text fingerprint analysis jobs.
Operation description
- After a media fingerprint analysis job is submitted, the media fingerprinting service compares the fingerprints of the job input with those of the media files in the media fingerprint library. You can call this operation to query the job results.
- You can query the results of a text fingerprint analysis job only in the China (Shanghai) region.
QPS limits
You can call this API operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.
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 Resourcesis 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 |
|---|---|---|---|---|
| mts:QueryFpShotJobList | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| JobIds | string | No | The ID of the media fingerprint analysis job that you want to query. To view the job ID, log on to the ApsaraVideo Media Processing (MPS) console, click Tasks in the left-side navigation pane, and then click the Video DNA tab on the Tasks page. You can query up to 10 media fingerprint analysis jobs at a time. Separate multiple job IDs with commas (,). | 88c6ca184c0e47098a5b665e2a12**** |
| NextPageToken | string | No | The token that is used to retrieve the next page of the query results. You do not need to specify this parameter in the first request. The response to the first request contains this parameter, which you add to the next request. | 16f01ad6175e4230ac42bb5182cd**** |
| MaximumPageSize | long | No | The maximum number of entries to return on each page.
| 10 |
| State | string | No | The status of the jobs to be queried. Valid values:
| All |
| StartOfJobCreatedTimeRange | string | No | The beginning of the time range within which the jobs to be queried were created.
| 2021-12-22T03:48:05Z |
| EndOfJobCreatedTimeRange | string | No | The end of the time range within which the jobs to be queried were created.
| 2022-02-14T02:16:07Z |
| PipelineId | string | No | The ID of the MPS queue. To view the ID of the MPS queue, log on to the MPS console and choose Global Settings > Pipelines in the left-side navigation pane. | b11c171cced04565b1f38f1ecc39**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
"NextPageToken": "b11c171cced04565b1f38f1ecc39****",
"FpShotJobList": {
"FpShotJob": [
{
"FpShotResult": {
"AudioFpShots": {
"FpShot": [
{
"PrimaryKey": "498ac941373341599c4777c8d884****",
"FpShotSlices": {
"FpShotSlice": [
{
"Duplication": {
"Start": "0",
"Duration": "3"
},
"Similarity": "0",
"Input": {
"Start": "0",
"Duration": "5"
}
}
]
},
"Similarity": "0"
}
]
},
"FpShots": {
"FpShot": [
{
"PrimaryKey": "498ac941373341599c4777c8d884****",
"FpShotSlices": {
"FpShotSlice": [
{
"Duplication": {
"Start": "1260",
"Duration": "48"
},
"Similarity": "0",
"Input": {
"Start": "46",
"Duration": "48"
}
}
]
},
"Similarity": "0.8914769887924194"
}
]
},
"TextFpShots": {
"TextFpShot": [
{
"PrimaryKey": "3e34ac649945b53a1b0f863ce030****",
"Similarity": "1.0",
"TextFpShotSlices": {
"TextFpShotSlice": [
{
"Similarity": "1.0",
"InputText": "It's snowy today.\n",
"DuplicationText": "It's snowy today.\n",
"InputFragment": {
"Start": "0",
"Duration": "3"
}
}
]
}
}
]
}
},
"CreationTime": "2017-01-10T12:00:00Z",
"FinishTime": "0",
"State": "Success",
"Message": "The parameter \\\"Id\\\" is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long",
"FpShotConfig": {
"PrimaryKey": "3ca84a39a9024f19853b21be9cf9****",
"SaveType": "save",
"FpDBId": "2288c6ca184c0e47098a5b665e2a12****"
},
"FileId": "ebb51ee30f0b49aba959823fa991****",
"UserData": "testid-001",
"Duration": 5,
"Code": "InvalidParameter.UUIDFormatInvalid",
"InputFile": {
"Object": "test.mp4",
"Location": "oss-cn-beijing",
"Bucket": "oss-test"
},
"PipelineId": "88c6ca184c0e47098a5b665e2a12****",
"Id": "88c6ca184c0e47098a5b665e2a12****",
"Input": "{\"Bucket\":\"oss-test\",\"Location\":\"oss-cn-beijing\",\"Object\":\"test.mp4\"}"
}
]
},
"NonExistIds": {
"String": [
"ae687c02fe944327ba9631e50da23128****"
]
}
}Error codes
For a list of error codes, visit the Service error codes.