文档

SubmitFpFileDeleteJob - 提交删除DNA文件

更新时间:

提交删除DNA文件作业。

接口说明

使用限制

  • 本接口一次最多删除 200 个 DNA 文件。

  • 本接口当前支持地域为华北 2(北京)、华东 1(杭州)、华东 2(上海)、亚太东南 1(新加坡)。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

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

ed450ea0bfbd41e29f80a401fb4d****
FpDBIdstring

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

88c6ca184c0e432bbf5b665e2a15****
UserDatastring

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

example data
FileIdsstring

需要删除的文件 ID,用半角逗号(,)分隔,一次最多删除 200 个。可以从查询 DNA 库文件列表的返回参数中获取。

41e6536e4f2250e2e9bf26cdea19****
PrimaryKeysstring

需要删除的文件 PrimaryKey,用半角逗号(,)分隔,一次最多删除 200 个。可以从查询 DNA 库文件列表的返回参数中获取。

说明 此参数当前仅支持华北 2(北京)、华东 1(杭州)、华东 2(上海)地域使用。
24e0fba7188fae707e146esa54****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

D127C68E-F1A1-4CE5-A874-8FF724881A12
JobIdstring

DNA 文件删除作业 ID。

39f8e0bc005e4f309379701645f4****

示例

正常返回示例

JSON格式

{
  "RequestId": "D127C68E-F1A1-4CE5-A874-8FF724881A12",
  "JobId": "39f8e0bc005e4f309379701645f4****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.DBNotExistThe DNA database does not exist.指纹数据库不存在
500InternalErrorThe operation has failed due to some unknown error, exception or failure.-

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