All Products
Search
Document Center

Intelligent Media Services:ListDNAFiles

Last Updated:Dec 16, 2024

Queries a list of files in a media fingerprint library.

Operation description

You can call this operation to query files in a media fingerprint library based on the library ID. The queried results can be paginated.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
ice:ListDNAFiles
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NextPageTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

ae0fd49c0840e14daf0d66a75b83****
PageSizeintegerNo

The number of entries per page. Default value: 20. Valid values: 1 to 100.

10
DBIdstringYes

The ID of the media fingerprint library.

2288c6ca184c0e47098a5b665e2a12****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

2AE89FA5-E620-56C7-9B80-75D09757385A
NextPageTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

ae0fd49c0840e14daf0d66a75b83****
FileListarray<object>

The queried files.

DNAFileobject

The queried file.

PrimaryKeystring

The primary key of the file.

ae0fd49c0840e14daf0d66a75b83****
InputFileobject

The Object Storage Service (OSS) information about the input file.

Objectstring

The name of the OSS object that is used as the input file.

example-****.mp4
Locationstring

The OSS region in which the input file resides.

oss-cn-beijing
Bucketstring

The name of the OSS bucket in which the input file is stored.

example-bucket

Examples

Sample success responses

JSONformat

{
  "RequestId": "2AE89FA5-E620-56C7-9B80-75D09757385A",
  "NextPageToken": "ae0fd49c0840e14daf0d66a75b83****",
  "FileList": [
    {
      "PrimaryKey": "ae0fd49c0840e14daf0d66a75b83****",
      "InputFile": {
        "Object": "example-****.mp4",
        "Location": "oss-cn-beijing",
        "Bucket": "example-bucket"
      }
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-05-25The internal configuration of the API is changed, but the call is not affectedView Change Details