ListFpShotDB - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Query DNA databases.

Operation description

This operation returns the status and information of one or more media fingerprinting libraries based on their IDs.
The text fingerprinting feature is available only in the China (Shanghai) region.
This operation queries a maximum of 10 media fingerprinting libraries at a time.

QPS limits

The limit on calls to this operation is 100 queries per second (QPS) per user. If you exceed the limit, API calls are throttled. This can impact your business. Call this operation at a reasonable rate. For more information, see QPS limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mts:ListFpShotDB

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FpDBIds	string	No	The IDs of the media fingerprinting libraries that you want to query. To obtain the library IDs, call the SubmitFpShotDB operation. You can specify up to 10 IDs. Separate multiple IDs with commas (,).	2288c6ca184c0e47098a5b665e2a12**,ae687c02fe944327ba9631e50da2**

Response elements

Element	Type	Description	Example
	object	The response parameters.
FpShotDBList	object
FpShotDB	array<object>	A list of media fingerprint libraries.
	object	The details of the media fingerprinting library.
Status	string	The status of the media fingerprinting library. Valid values: offline: The library is offline. active: The library is active. paused: The library is paused. deleted: The library is deleted.	active
Description	string	The description of the media fingerprinting library.	这是一个文本DNA库
Name	string	The name of the media fingerprinting library.	test-****
ModelId	integer	The model ID of the media fingerprinting library. The model ID for text fingerprinting is 11, for video fingerprinting is 12, for audio fingerprinting is 13, and for image fingerprinting is 14.	11
FpDBId	string	The ID of the media fingerprinting library.	88c6ca184c0e47098a5b665e2a12****
RequestId	string	The ID of the request.	25818875-5F78-4A13-BEF6-D7393642CA58
NonExistIds	object
String	array	The IDs of the media fingerprinting libraries that do not exist.
	string	The ID of a media fingerprinting library that does not exist. This parameter is not returned if all specified library IDs exist.	ae687c02fe944327ba9631e50da2****

Examples

Success response

JSON format

{
  "FpShotDBList": {
    "FpShotDB": [
      {
        "Status": "active",
        "Description": "这是一个文本DNA库",
        "Name": "test-****",
        "ModelId": 11,
        "FpDBId": "88c6ca184c0e47098a5b665e2a12****"
      }
    ]
  },
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "NonExistIds": {
    "String": [
      "ae687c02fe944327ba9631e50da2****"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.