文档

ListFpShotFiles - 查询DNA库文件列表

更新时间:

查询DNA库文件列表。

接口说明

  • 本接口通过 DNA 库 ID 查询文件列表,支持分页查询。
  • 本接口目前支持使用的地域为华北 2(北京)、华东 1(杭州)、华东 2(上海)、亚太东南 1(新加坡)。

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
NextPageTokenstring

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

ae0fd49c0840e14daf0d66a75b83****
PageSizeinteger

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

20
FpDBIdstring

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

2288c6ca184c0e47098a5b665e2a12****
StartTimestring

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

说明 此参数支持使用的地域为华北 2(北京)、华东 1(杭州)、华东 2(上海),暂不支持亚太东南 1(新加坡)地域使用。
2022-09-01T00:00:28Z
EndTimestring

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

说明 此参数支持使用的地域为华北 2(北京)、华东 1(杭州)、华东 2(上海),暂不支持亚太东南 1(新加坡)地域使用。
2022-09-08T23:32:56Z

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

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

下一页 Token。

ae0fd49c0840e14daf0d66a75b83****
FpShotFileListobject []

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

PrimaryKeystring

视频唯一主键。

fb712a6890464059b1b2ea7c8647****
InputFileobject

作业输入。

Objectstring

输入文件的 OSS Object。

example-****.mp4
Locationstring

输入文件的 OSS Location。

oss-cn-beijing
Bucketstring

输入文件的 OSS Bucket。

example-bucket-****
FileIdstring

视频文件 ID。

41e6536e4f2250e2e9bf26cdea19****
StoreTimestring

入库时间。日期格式按照 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错误码错误信息描述
400InvalidParameter.OutOfRangeThe specified parameter %s is out of range.参数无效超出指定范围
500InternalErrorThe operation has failed due to some unknown error, exception or failure.-

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

  • 本页导读 (1)