文档

SubmitFpDBDeleteJob - 提交清空或删除DNA库

更新时间:

提交清空或删除DNA库作业。

接口说明

本接口通过指定 DNA 库 ID 实现清空(删除 DNA 库中所有内容,不会删除 DNA 库)或删除(直接删除 DNA 库)操作,如果不指定操作类型,则默认清空 DNA 库。其中,modelId 在[11, 14]内的新版本指纹库仅支持删除操作,即 DelType=Delete。

QPS 限制

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

调试

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

授权信息

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

请求参数

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

管道 ID,用于绑定消息通知。可以通过 MPS 控制台 > 全局设置 > 管道获取。

fb712a6890464059b1b2ea7c8647****
FpDBIdstring

DNA 库 ID,可以从提交新建 DNA 库的返回参数中获取。

88c6ca184c0e47098a5b665e2a12****
UserDatastring

用户自定义数据,支持中英文、数字等,最大长度 128 个字节。

example data
DelTypestring

操作类型,支持类型:

  • Purge:清空 DNA 库,即删除 DNA 库中所有内容,不会删除 DNA 库。

  • Delete:删除 DNA 库,即删除此 DNA 库。其中,modelId 在[11, 14]内的新版本指纹库仅支持删除操作。

  • 默认值:Purge

Purge

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

4247B23C-26DE-529F-8D9F-FD6811AE979B
JobIdstring

清空或删除 DNA 库作业 ID。建议您保存此 ID 便于后续使用其他接口时使用。

d98459323c024947a104f6a50cbf****

示例

正常返回示例

JSON格式

{
  "RequestId": "4247B23C-26DE-529F-8D9F-FD6811AE979B",
  "JobId": "d98459323c024947a104f6a50cbf****"
}

错误码

HTTP status code错误码错误信息
500InternalErrorThe operation has failed due to some unknown error, exception or failure.

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

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