ListFpShotDB - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Queries media fingerprint libraries.

Operation description

You can call this operation to query the status and information about the media fingerprint libraries based on the specified IDs.
You can query text fingerprint libraries only in the China (Shanghai) region.
You can call this operation to query up to 10 media fingerprint libraries.

QPS limit

You can call this operation up to 500 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 limit.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
FpDBIds	string	No	The ID of the media fingerprint library. You can obtain the library ID from the response parameters of the CreateFpShotDB operation. You can query up to 10 libraries at a time. Separate multiple library IDs with commas (,).	2288c6ca184c0e47098a5b665e2a12**,ae687c02fe944327ba9631e50da2**

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
FpShotDBList	object []	The media fingerprint libraries.
Status	string	The status of the media fingerprint library. Default value: offline. **Valid values: offline: The media fingerprint library is offline. active: The media fingerprint library is online. paused: The media fingerprint library is paused. deleted**: The media fingerprint library is deleted.	active
Description	string	The description of the media fingerprint library.	The library is a text fingerprint library.
Name	string	The name of the media fingerprint library.	test-****
ModelId	integer	The model ID of the media fingerprint library. A value of 11 indicates that the library is a text fingerprint library. A value of 12 indicates that the library is a video fingerprint library. A value of 13 indicates that the library is an audio fingerprint library. A value of 14 indicates that the library is an image fingerprint library.	11
FpDBId	string	The ID of the media fingerprint library.	88c6ca184c0e47098a5b665e2a12****
RequestId	string	The ID of the request.	25818875-5F78-4A13-BEF6-D7393642CA58
NonExistIds	array	The IDs of the media fingerprint libraries that do not exist.
	string	The IDs of the media fingerprint libraries that do not exist. If all the queried libraries exist, the response does not contain this parameter.	ae687c02fe944327ba9631e50da2****

Examples

Sample success responses

JSONformat

{
  "FpShotDBList": {
    "FpShotDB": [
      {
        "Status": "active",
        "Description": "The library is a text fingerprint library.\n",
        "Name": "test-****",
        "ModelId": 11,
        "FpDBId": "88c6ca184c0e47098a5b665e2a12****"
      }
    ]
  },
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "NonExistIds": {
    "String": [
      "ae687c02fe944327ba9631e50da2****"
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.