Query media fingerprinting libraries by calling ListFpShotDB - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Queries DNA libraries.

Operation description

This operation returns the status and information of DNA libraries based on their IDs.
Text DNA-related features are currently supported only in the China (Shanghai) region.
You can query up to 10 DNA libraries in a single call.

QPS limits

The QPS limit for a single user is 100 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Make API calls 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 list of DNA library IDs. You can obtain the IDs from the response parameters of the Submit a new DNA library operation. You can query up to 10 IDs at a time. Separate multiple IDs with commas (,).	2288c6ca184c0e47098a5b665e2a12**,ae687c02fe944327ba9631e50da2**

Response elements

Element	Type	Description	Example
	object	The response parameters.
FpShotDBList	object
FpShotDB	array<object>	The list of DNA libraries.
	object	The details of the DNA library.
Status	string	The status of the DNA library. Default value: offline. active indicates that the DNA library is available. Valid values: offline: offline active: online paused: paused deleted: deleted	active
Description	string	The description of the DNA library.	This is a text DNA library.
Name	string	The name of the DNA library.	test-****
ModelId	integer	The model ID of the DNA library. The model ID is 11 for text DNA, 12 for video DNA, 13 for audio DNA, and 14 for image DNA.	11
FpDBId	string	The ID of the DNA library.	88c6ca184c0e47098a5b665e2a12****
RequestId	string	The request ID.	25818875-5F78-4A13-BEF6-D7393642CA58
NonExistIds	object
String	array	The list of DNA library IDs that do not exist.
	string	The DNA library ID that does not exist. This parameter is not returned if no data exists.	ae687c02fe944327ba9631e50da2****

Examples

Success response

JSON format

{
  "FpShotDBList": {
    "FpShotDB": [
      {
        "Status": "active",
        "Description": "This is a text DNA library.",
        "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.