Query media fingerprint analysis jobs using QueryFpShotJobList - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Queries DNA job results. This operation supports querying results of all types of DNA jobs.

Operation description

After you submit a DNA job, the DNA service performs DNA comparison. You can call this operation to query job results.
Querying text DNA jobs is supported only in the China (Shanghai) region.
This operation supports querying DNA job information only within the last six months.

QPS limit

The single-user QPS limit for this operation is 100 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately. For more information, see QPS limit.

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

mts:QueryFpShotJobList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobIds	string	No	The list of DNA job IDs to query. You can specify up to 10 IDs at a time, separated by commas (,).	88c6ca184c0e47098a5b665e2a12****
NextPageToken	string	No	The pagination token. You do not need to specify this parameter for the first request. The service returns this token, and you can pass it in the second request.	16f01ad6175e4230ac42bb5182cd****
MaximumPageSize	integer	No	The maximum number of results to return per page. Default value: 10. Valid values: 1 to 30.	10
State	string	No	The job state to query. Valid values: All: all states. Queuing: queued. Analysing: being analyzed. Fail: failed. Success: succeeded.	All
StartOfJobCreatedTimeRange	string	No	The earliest job creation time. The date is in ISO 8601 format and must be in UTC. Format: YYYY-MM-DDThh:mm:ssZ.	2021-12-22T03:48:05Z
EndOfJobCreatedTimeRange	string	No	The latest job creation time. The date is in ISO 8601 format and must be in UTC. Format: YYYY-MM-DDThh:mm:ssZ.	2022-02-14T02:16:07Z
PipelineId	string	No	The MPS queue ID. You can obtain the ID from the ApsaraVideo Media Processing console > Global Settings > Pipelines and Callbacks.	b11c171cced04565b1f38f1ecc39****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4A13-BEF6-D7393642CA58
NextPageToken	string	The pagination token for the next page. Record this value and pass it in the next request.	b11c171cced04565b1f38f1ecc39****
FpShotJobList	object
FpShotJob	array<object>	The DNA job information.
	array<object>	The details of the DNA job.
FpShotResult	object	The DNA job query result.
AudioFpShots	object
FpShot	array<object>	The query results for audio DNA.
	array<object>	The detailed query results for audio DNA.
PrimaryKey	string	The primary key.	498ac941373341599c4777c8d884****
FpShotSlices	object
FpShotSlice	array<object>	The similar audio segments.
	array<object>	The details of the similar audio segments.
Duplication	object	The start time and duration of the audio segment in the DNA library.
Start	string	The start time.	0
Duration	string	The duration.	3
Similarity	string	The similarity of the audio segment.	0
Input	object	The start time and duration of the input audio segment.
Start	string	The start time.	0
Duration	string	The duration.	5
Similarity	string	The overall similarity of the audio.	0
FpShots	object
FpShot	array<object>	The query results for video DNA.
	array<object>	The detailed query results for video DNA.
PrimaryKey	string	The primary key of the video.	498ac941373341599c4777c8d884****
FpShotSlices	object
FpShotSlice	array<object>	The similar video segments.
	array<object>	The details of the similar video segments.
Duplication	object	The start time and duration of the video segment in the DNA library.
Start	string	The start time.	1260
Duration	string	The duration.	48
Similarity	string	The similarity of the video segment.	0
Input	object	The start time and duration of the input video segment.
Start	string	The start time.	46
Duration	string	The duration.	48
Similarity	string	The overall similarity of the video. Note The overall similarity is the average of the similarity values of individual segments. If multiple similar segments are found in the DNA library, multiple hits are returned.	0.8914769887924194
TextFpShots	object
TextFpShot	array<object>	The text DNA query result.
	array<object>	The details of the text DNA query result.
PrimaryKey	string	The unique primary key of the text.	3e34ac649945b53a1b0f863ce030****
Similarity	string	The text similarity.	1.0
TextFpShotSlices	object
TextFpShotSlice	array<object>	The duplicate text.
	array<object>	The details of the duplicate text.
Similarity	string	The confidence score for the matched segment.	1.0
InputText	string	The text segment from the input that matched a segment in the base library.	今天下雪了
DuplicationText	string	The text segment from the base library that was matched.	今天下雪了
InputFragment	object	The start time and duration of the matched segment in the input file.
Start	string	The start time.	0
Duration	string	The duration.	3
CreationTime	string	The creation time.	2017-01-10T12:00:00Z
FinishTime	string	The completion time.	0
State	string	The job state. Valid values: Queuing: Queued. Analysing: Being analyzed. Success: Succeeded. Fail: Failed.	Success
Message	string	The error message returned when the analysis fails. This parameter is not returned if the job succeeds.	The parameter \"Id\" is invalid.A uuid must:1)be comprised of chracters[a-f],numbers[0-9];2)be 32 characters long
FpShotConfig	object	The configuration.
PrimaryKey	string	The unique primary key of the video. The uniqueness is guaranteed by the user.	3ca84a39a9024f19853b21be9cf9****
SaveType	string	The storage type. Valid values: nosave: Do not save to the library. save: Deduplicate and save to the library. forcesave: Force save to the library.	save
FpDBId	string	The DNA library ID.	2288c6ca184c0e47098a5b665e2a12****
FileId	string	The file ID.	ebb51ee30f0b49aba959823fa991****
UserData	string	The custom data.	testid-001
Duration	integer	The duration of the input file, in seconds.	5
Code	string	The error code returned when the analysis fails.	InvalidParameter.UUIDFormatInvalid
InputFile	object	The job input.
Object	string	The OSS object of the job input.	test.mp4
Location	string	The OSS location of the job input.	oss-cn-beiing
Bucket	string	The OSS bucket of the job input.	oss-test
PipelineId	string	The MPS queue ID.	88c6ca184c0e47098a5b665e2a12****
Id	string	The job ID.	88c6ca184c0e47098a5b665e2a12****
Input	string	The job input.	{"Bucket":"oss-test","Location":"oss-cn-beiing","Object":"test.mp4"}
NonExistIds	object
String	array	The list of non-existent job IDs.
	string	The list of non-existent job IDs. This parameter is not returned if no data exists.	ae687c02fe944327ba9631e50da23128****

Examples

Success response

JSON format

{
  "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": "今天下雪了",
                      "DuplicationText": "今天下雪了",
                      "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-beiing",
          "Bucket": "oss-test"
        },
        "PipelineId": "88c6ca184c0e47098a5b665e2a12****",
        "Id": "88c6ca184c0e47098a5b665e2a12****",
        "Input": "{\"Bucket\":\"oss-test\",\"Location\":\"oss-cn-beiing\",\"Object\":\"test.mp4\"}"
      }
    ]
  },
  "NonExistIds": {
    "String": [
      "ae687c02fe944327ba9631e50da23128****"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.