All Products
Search
Document Center

ApsaraVideo Media Processing:ListFpShotDB

Last Updated:Sep 27, 2024

Queries media fingerprint libraries.

Operation description

  • You can call this operation to query the status and information about the media fingerprint libraries based on the specified IDs.
  • You can query text fingerprint libraries only in the China (Shanghai) region.
  • You can call this operation to query up to 10 media fingerprint libraries.

QPS limit

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
mts:ListFpShotDBget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FpDBIdsstringNo

The ID of the media fingerprint library. You can obtain the library ID from the response parameters of the CreateFpShotDB operation. You can query up to 10 libraries at a time. Separate multiple library IDs with commas (,).

2288c6ca184c0e47098a5b665e2a12****,ae687c02fe944327ba9631e50da2****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

FpShotDBListarray<object>

The media fingerprint libraries.

FpShotDBobject

The details of the media fingerprint library.

Statusstring

The status of the media fingerprint library. Default value: offline. ****Valid values:

  • offline: The media fingerprint library is offline.
  • active: The media fingerprint library is online.
  • paused: The media fingerprint library is paused.
  • deleted: The media fingerprint library is deleted.
active
Descriptionstring

The description of the media fingerprint library.

The library is a text fingerprint library.
Namestring

The name of the media fingerprint library.

test-****
ModelIdinteger

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

11
FpDBIdstring

The ID of the media fingerprint library.

88c6ca184c0e47098a5b665e2a12****
RequestIdstring

The ID of the request.

25818875-5F78-4A13-BEF6-D7393642CA58
NonExistIdsarray

The IDs of the media fingerprint libraries that do not exist.

Stringstring

The IDs of the media fingerprint libraries that do not exist. If all the queried libraries exist, the response does not contain this parameter.

ae687c02fe944327ba9631e50da2****

Examples

Sample success responses

JSONformat

{
  "FpShotDBList": {
    "FpShotDB": [
      {
        "Status": "active",
        "Description": "The library is a text fingerprint library.\n",
        "Name": "test-****",
        "ModelId": 11,
        "FpDBId": "88c6ca184c0e47098a5b665e2a12****"
      }
    ]
  },
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "NonExistIds": {
    "String": [
      "ae687c02fe944327ba9631e50da2****"
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.