ListFpShotFiles - 查询DNA库文件列表

更新时间:
复制 MD 格式

查询DNA库文件列表。

接口说明

  • 本接口通过 DNA 库 ID 查询文件列表,支持分页查询。

  • 本接口目前支持使用的地域为华北 2(北京)、华东 1(杭州)、华东 2(上海)、亚太东南 1(新加坡)、沙特(利雅得)。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mts:ListFpShotFiles

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

NextPageToken

string

否

分页查询。请求第一页时,NextPageToken 为空;请求后续文件时需传入前一页查询结果中的 NextPageToken 值。

ae0fd49c0840e14daf0d66a75b83****

PageSize

integer

否

单页数据个数,默认为 20。

20

FpDBId

string

是

需要查询的 DNA 库 ID。可以从提交新建 DNA 库的返回参数中获取。

2288c6ca184c0e47098a5b665e2a12****

StartTime

string

否

入库时间范围开始时间。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为YYYY-MM-DDThh:mm:ssZ。

说明

此参数支持使用的地域为华北 2(北京)、华东 1(杭州)、华东 2(上海),暂不支持亚太东南 1(新加坡)地域使用。

2022-09-01T00:00:28Z

EndTime

string

否

入库时间范围结束时间。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为YYYY-MM-DDThh:mm:ssZ。

说明

此参数支持使用的地域为华北 2(北京)、华东 1(杭州)、华东 2(上海),暂不支持亚太东南 1(新加坡)地域使用。

2022-09-08T23:32:56Z

返回参数

名称

类型

描述

示例值

object

返回参数。

RequestId

string

请求 ID。

25818875-5F78-4A13-BEF6-D7393642CA58

NextPageToken

string

下一页 Token。

ae0fd49c0840e14daf0d66a75b83****

FpShotFileList

object

FpShotFile

array<object>

视频 DNA 文件列表。更多信息请参见数据类型 FpShotFile。

array<object>

视频 DNA 文件详细信息。

PrimaryKey

string

视频唯一主键。

fb712a6890464059b1b2ea7c8647****

InputFile

object

作业输入。

Object

string

输入文件的 OSS Object。

example-****.mp4

Location

string

输入文件的 OSS Location。

oss-cn-beijing

Bucket

string

输入文件的 OSS Bucket。

example-bucket-****

FileId

string

视频文件 ID。

41e6536e4f2250e2e9bf26cdea19****

StoreTime

string

入库时间。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为YYYY-MM-DDThh:mm:ssZ。

说明

此参数支持使用的地域为华北 2(北京)、华东 1(杭州)、华东 2(上海),暂不支持亚太东南 1(新加坡)地域使用。

2022-09-08T23:32:56Z

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "NextPageToken": "ae0fd49c0840e14daf0d66a75b83****",
  "FpShotFileList": {
    "FpShotFile": [
      {
        "PrimaryKey": "fb712a6890464059b1b2ea7c8647****",
        "InputFile": {
          "Object": "example-****.mp4",
          "Location": "oss-cn-beijing",
          "Bucket": "example-bucket-****"
        },
        "FileId": "41e6536e4f2250e2e9bf26cdea19****",
        "StoreTime": "2022-09-08T23:32:56Z"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter.OutOfRange The specified parameter %s is out of range. 参数无效超出指定范围
500 InternalError The operation has failed due to some unknown error, exception or failure.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。