Submits a job of creating a media fingerprint library.

Usage notes

  • You can call this operation to submit a job to create a video or text fingerprint library. You can use a text fingerprint library to store fingerprints for text.
  • You can submit a job of creating a text fingerprint library only in the China (Shanghai) region. By default, you can submit up to 10 jobs of creating a video fingerprint library to an ApsaraVideo Media Processing (MPS) queue at a time. If you submit more than 10 jobs at a time, the call may fail.

QPS limit

You can call this operation up to 100 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 CreateFpShotDB

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

Name String Yes example name

The name of the media fingerprint library to be created.

ModelId Integer No 11

The model ID of the media fingerprint library. To create a text fingerprint library, set the parameter to 11. To create a video fingerprint library, set the parameter to 12. To create an audio fingerprint library, set the parameter to 13. A value of 14 indicates that the library is an image fingerprint library.

Config String No null

The configurations of the media fingerprint library. By default, this parameter is empty. You can customize the configurations based on your business requirements. The value is a string in the JSON format.

Description String No The library is a text fingerprint library.

The description of the media fingerprint library.

Response parameters

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

The ID of the request.

FpShotDB Object

The details of the media fingerprint library.

Description String The library is a text fingerprint library.

The description of the media fingerprint library.

State String offline

The status of the media fingerprint library. After the media fingerprint library is created, it enters the offline state. After the media fingerprint library is processed at the backend, it enters the active state.

Name String example-name-****

The name of the media fingerprint library.

FpDBId String 88c6ca184c0e47098a5b665e2a12****

The ID of the media fingerprint library. We recommend that you keep this ID for subsequent operation calls.

ModelId Integer 11

The model ID of the media fingerprint library.

Config String null

The configurations of the media fingerprint library.

Examples

Sample requests

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=CreateFpShotDB
&Name=example name
&ModelId=11
&Config=null
&Description=The library is a text fingerprint library.
&<Common request parameters>

Sample success responses

XML format 

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

<CreateFpShotDBResponse>
    <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
    <FpShotDB>
        <Description>The library is a text fingerprint library.</Description>
        <State>offline</State>
        <Name>example-name-****</Name>
        <FpDBId>88c6ca184c0e47098a5b665e2a12****</FpDBId>
        <ModelId>11</ModelId>
        <Config>null</Config>
    </FpShotDB>
</CreateFpShotDBResponse>

JSON format 

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

{
  "RequestId" : "25818875-5F78-4A13-BEF6-D7393642CA58",
  "FpShotDB" : {
    "Description" : "The library is a text fingerprint library.",
    "State" : "offline",
    "Name" : "example-name-****",
    "FpDBId" : "88c6ca184c0e47098a5b665e2a12****",
    "ModelId" : 11,
    "Config" : "null"
  }
}

Error codes

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