Submits a job of creating a media fingerprint library.
Operation description
- 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. 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
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| mts:CreateFpShotDB | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Name | string | Yes | The name of the media fingerprint library. | example name |
| ModelId | integer | No | 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. To create an image fingerprint library, set the parameter to 14. | 11 |
| Config | string | No | The configurations of the media fingerprint library. By default, this parameter is left empty. You can customize the configurations based on your business requirements. The value must be a string in the JSON format. | null |
| Description | string | No | The description of the media fingerprint library. | The library is a text fingerprint library. |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
"FpShotDB": {
"Description": "The library is a text fingerprint library.\n",
"State": "offline",
"Name": "example-name-****",
"FpDBId": "88c6ca184c0e47098a5b665e2a12****",
"ModelId": 11,
"Config": "null"
}
}Error codes
For a list of error codes, visit the Service error codes.