文档

CreateFpShotDB - 创建DNA库

更新时间:

提交新建DNA库作业。

接口说明

  • 本接口可以新建视频、音频、图片和文本 DNA 库。
  • 文本 DNA 相关接口目前仅支持华东 2(上海)地域使用。
  • DNA 管道默认并发为 10,超过可能会导致接口调用失败。

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mts:CreateFpShotDB
  • 全部资源
    *

请求参数

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

DNA 库名称。

example name
ModelIdinteger

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

12
Configstring

指纹库配置。默认为空,做定制化配置。字符串类型,JSON 格式。

null
Descriptionstring

DNA 库描述。

这是一个文本DNA库

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

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

DNA 库详细信息。

Descriptionstring

DNA 库描述。

这是一个文本DNA库
Statestring

DNA 库的状态。新建成功后默认为 offline 状态,待后台处理完成后会自动转换成 active 状态。

offline
Namestring

DNA 库名称。

example-name-****
FpDBIdstring

DNA 库 ID。建议您保存此 ID 便于后续调用其他相关接口时使用。

88c6ca184c0e47098a5b665e2a12****
ModelIdinteger

DNA 库模型 ID。

11
Configstring

DNA 库配置。

null

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "FpShotDB": {
    "Description": "这是一个文本DNA库",
    "State": "offline",
    "Name": "example-name-****",
    "FpDBId": "88c6ca184c0e47098a5b665e2a12****",
    "ModelId": 11,
    "Config": "null"
  }
}

错误码

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