Queries media fingerprint libraries.

Usage notes

  • You can call this operation to query the status and information of the media fingerprint libraries with 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. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListFpShotDB

The operation that you want to perform. Set the value to ListFpShotDB.

FpDBIds String No 2288c6ca184c0e47098a5b665e2a12****,ae687c02fe944327ba9631e50da2****

The IDs of the media fingerprint libraries. You can obtain the library IDs from the response parameters of the CreateFpShotDB operation. You can query up to 10 libraries at a time. Separate multiple library IDs with commas (,).

Response parameters

Parameter Type Example Description
FpShotDBList Array of FpShotDB

The array of media fingerprint libraries.

FpShotDB
Status String active

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.
Description String The library is a text fingerprint library.

The description of the media fingerprint library.

Name String test-****

The name of the media fingerprint library.

ModelId Integer 11

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.

FpDBId String 88c6ca184c0e47098a5b665e2a12****

The ID of the media fingerprint library.

RequestId String 25818875-5F78-4A13-BEF6-D7393642CA58

The ID of the request.

NonExistIds Array of String ae687c02fe944327ba9631e50da2****

The IDs of the media fingerprint libraries that do not exist. If all the queried libraries exist, the response does not contain this parameter.

Examples

Sample requests

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=ListFpShotDB
&FpDBIds=2288c6ca184c0e47098a5b665e2a12****,ae687c02fe944327ba9631e50da2****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListFpShotDBResponse>
    <FpShotDBList>
        <Status>active</Status>
        <Description>The library is a text fingerprint library.</Description>
        <Name>test-****</Name>
        <ModelId>11</ModelId>
        <FpDBId>88c6ca184c0e47098a5b665e2a12****</FpDBId>
    </FpShotDBList>
    <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
    <NonExistIds>ae687c02fe944327ba9631e50da2****</NonExistIds>
</ListFpShotDBResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.