ListFpShotDB - 查询DNA库

查询DNA库。

接口说明

  • 本接口根据DNA库ID返回DNA库的状态、信息等。
  • 文本DNA相关功能目前仅支持华东2(上海)地域使用。
  • 本接口一次最多查询10个DNA库。

QPS限制

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

调试

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

调试

授权信息

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

请求参数

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

DNA库ID列表,可以从提交新建DNA库的返回参数中获取。⼀次最多查10个,ID之间⽤半角逗号(,)分隔。

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

返回参数

名称类型描述示例值
object

返回参数。

FpShotDBListarray

DNA库列表。

object

DNA库详细信息。

Statusstring

DNA库的状态。默认值:offline(离线)。active表示DNA库可用。可取值:

  • offline:离线。

  • active:在线。

  • paused:暂停。

  • deleted:删除。

active
Descriptionstring

DNA库描述。

这是一个文本DNA库
Namestring

DNA库名称。

test-****
ModelIdinteger

DNA库模型ID。⽂本DNA ModelId为11,视频DNA ModelId为12,音频DNA ModelId为13,图片DNA ModelId为14

11
FpDBIdstring

DNA库ID。

88c6ca184c0e47098a5b665e2a12****
RequestIdstring

请求ID。

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

不存在的DNA库ID列表。

string

不存在的DNA库ID,无数据时该参数不返回。

ae687c02fe944327ba9631e50da2****

示例

正常返回示例

JSON格式

{
  "FpShotDBList": {
    "FpShotDB": [
      {
        "Status": "active",
        "Description": "这是一个文本DNA库",
        "Name": "test-****",
        "ModelId": 11,
        "FpDBId": "88c6ca184c0e47098a5b665e2a12****"
      }
    ]
  },
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "NonExistIds": {
    "String": [
      "ae687c02fe944327ba9631e50da2****"
    ]
  }
}

错误码

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

阿里云首页 媒体处理 相关技术圈