Queries media files in a media fingerprint library.

Usage notes

You can call this operation to query media files in a specified media fingerprint library based on the library ID. This operation supports paged queries.

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 ListFpShotFiles

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

NextPageToken String No ae0fd49c0840e14daf0d66a75b83****

The token of the next page. This parameter is specified if you require paged queries. When you request the first page of query results, leave the NextPageToken parameter empty. When you request more query results, specify the value of the NextPageToken parameter returned in the query results on the previous page.

PageSize Integer No 20

The number of entries to return on each page. Default value: 20.

FpDBId String Yes 2288c6ca184c0e47098a5b665e2a12****

The ID of the media fingerprint library whose files you want to query. You can obtain the library ID from the response parameters of the CreateFpShotDB operation.

Response parameters

Parameter Type Example Description
RequestId String 25818875-5F78-4A13-BEF6-D7393642CA58

The ID of the request.

NextPageToken String ae0fd49c0840e14daf0d66a75b83****

The token of the next page.

FpShotFileList Array of FpShotFile

The media fingerprint files. For more information, see the "FpShotFile" section of the Data types topic.

FpShotFile
PrimaryKey String fb712a6890464059b1b2ea7c8647****

The unique primary key of the video.

InputFile Object

The information about the job input.

Object String example-****.mp4

The name of the Object Storage Service (OSS) object that is used as the input file.

Location String oss-cn-beijing

The ID of the OSS region in which the input file resides.

Bucket String example-bucket-****

The name of the OSS bucket in which the input file is stored.

FileId String 41e6536e4f2250e2e9bf26cdea19****

The ID of the video file.

Examples

Sample requests

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=ListFpShotFiles
&NextPageToken=ae0fd49c0840e14daf0d66a75b83****
&PageSize=20
&FpDBId=2288c6ca184c0e47098a5b665e2a12****
&<Common request parameters>

Sample success responses

XML format 

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

<ListFpShotFilesResponse>
    <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
    <NextPageToken>ae0fd49c0840e14daf0d66a75b83****</NextPageToken>
    <FpShotFileList>
        <PrimaryKey>fb712a6890464059b1b2ea7c8647****</PrimaryKey>
        <InputFile>
            <Object>example-****.mp4</Object>
            <Location>oss-cn-beijing</Location>
            <Bucket>example-bucket-****</Bucket>
        </InputFile>
        <FileId>41e6536e4f2250e2e9bf26cdea19****</FileId>
    </FpShotFileList>
</ListFpShotFilesResponse>

JSON format 

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

{
  "RequestId" : "25818875-5F78-4A13-BEF6-D7393642CA58",
  "NextPageToken" : "ae0fd49c0840e14daf0d66a75b83****",
  "FpShotFileList" : [ {
    "PrimaryKey" : "fb712a6890464059b1b2ea7c8647****",
    "InputFile" : {
      "Object" : "example-****.mp4",
      "Location" : "oss-cn-beijing",
      "Bucket" : "example-bucket-****"
    },
    "FileId" : "41e6536e4f2250e2e9bf26cdea19****"
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 InvalidParameter.OutOfRange The specified parameter %s is out of range. The error message returned because the value of the parameter is invalid.
500 InternalError The operation has failed due to some unknown error, exception or failure. The error message returned because an internal error has occurred. Try again later.

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