文档

ListFpShotDB - 查询DNA库

更新时间:

查询DNA库。

接口说明

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

QPS 限制

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

调试

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

授权信息

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

请求参数

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

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

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

返回参数

名称类型描述示例值
object

返回参数。

FpShotDBListobject []

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****"
    ]
  }
}

错误码

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

  • 本页导读 (1)
文档反馈