调用CreateFpShotDB提交新建DNA库作业。
使用说明
- 本接口可以新建视频DNA库或文本DNA库(文本DNA库用于存储文本特征内容)。
- 文本DNA相关接口目前仅支持华东2(上海)地域使用。
- 视频DNA管道默认并发为10,超过可能会导致接口调用失败。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateFpShotDB | 系统规定参数。取值:CreateFpShotDB。 |
| Name | String | 是 | example name | DNA库名称。 |
| ModelId | Integer | 否 | 11 | DNA库模型ID。文本DNA Modelld为11,视频DNA ModelId为12,音频DNA ModelId为13,图片DNA ModelId为14。 |
| Config | String | 否 | null | 指纹库配置。默认为空,做定制化配置。字符串类型,JSON格式。 |
| Description | String | 否 | 这是一个文本DNA库 | DNA库描述。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 25818875-5F78-4A13-BEF6-D7393642CA58 | 请求ID。 |
| FpShotDB | Object | DNA库详细信息。 |
|
| Description | String | 这是一个文本DNA库 | DNA库描述。 |
| State | String | offline | DNA库的状态。新建成功后默认为offline状态,待后台处理完成后会自动转换成active状态。 |
| Name | String | example-name-**** | DNA库名称。 |
| FpDBId | String | 88c6ca184c0e47098a5b665e2a12**** | DNA库ID。建议您保存此ID便于后续调用其他相关接口时使用。 |
| ModelId | Integer | 11 | DNA库模型ID。 |
| Config | String | null | DNA库配置。 |
示例
请求示例
http(s)://mts.cn-shanghai.aliyuncs.com/?Action=CreateFpShotDB
&Name=example name
&ModelId=11
&Config=null
&Description=这是一个文本DNA库
&<公共请求参数>
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateFpShotDBResponse>
<RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
<FpShotDB>
<Description>这是一个文本DNA库</Description>
<State>offline</State>
<Name>example-name-****</Name>
<FpDBId>88c6ca184c0e47098a5b665e2a12****</FpDBId>
<ModelId>11</ModelId>
<Config>null</Config>
</FpShotDB>
</CreateFpShotDBResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "25818875-5F78-4A13-BEF6-D7393642CA58",
"FpShotDB" : {
"Description" : "这是一个文本DNA库",
"State" : "offline",
"Name" : "example-name-****",
"FpDBId" : "88c6ca184c0e47098a5b665e2a12****",
"ModelId" : 11,
"Config" : "null"
}
}
错误码
访问错误中心查看更多错误码。