调用ListFpShotDB查询DNA库。

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListFpShotDB

系统规定参数。取值:ListFpShotDB

FpDBIds String 2288c6ca184c0e47098a5b665e2a12****,ae687c02fe944327ba9631e50da2****

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

返回数据

名称 类型 示例值 描述
FpShotDBList Array of FpShotDB

DNA库列表。

FpShotDB
Status String active

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

  • offline:离线。
  • active:在线。
  • paused:暂停。
  • deleted:删除。
Description String 这是一个文本DNA库

DNA库描述。

Name String test-****

DNA库名称。

ModelId Integer 11

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

FpDBId String 88c6ca184c0e47098a5b665e2a12****

DNA库ID。

RequestId String 25818875-5F78-4A13-BEF6-D7393642CA58

请求ID。

NonExistIds Array of String ae687c02fe944327ba9631e50da2****

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

示例

请求示例

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=ListFpShotDB
&FpDBIds=2288c6ca184c0e47098a5b665e2a12****,ae687c02fe944327ba9631e50da2****
&>公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListFpShotDBResponse>
    <FpShotDBList>
        <Status>active</Status>
        <Description>这是一个文本DNA库</Description>
        <Name>test-****</Name>
        <ModelId>11</ModelId>
        <FpDBId>88c6ca184c0e47098a5b665e2a12****</FpDBId>
    </FpShotDBList>
    <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
    <NonExistIds>ae687c02fe944327ba9631e50da2****</NonExistIds>
</ListFpShotDBResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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