调用SubmitFpFileDeleteJob提交删除DNA文件作业。
使用限制
- 本接口一次最多删除200个DNA文件。
- 本接口当前支持地域为华北2(北京)、华东1(杭州)、华东2(上海)、亚太东南1(新加坡)。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | SubmitFpFileDeleteJob | 操作接口名,系统规定参数,取值:SubmitFpFileDeleteJob。 |
| PipelineId | String | 否 | ed450ea0bfbd41e29f80a401fb4d**** | 管道ID,用于绑定消息通知,可以通过MPS控制台 > 全局设置 > 管道获取。 |
| FpDBId | String | 是 | 88c6ca184c0e432bbf5b665e2a15**** | DNA库ID,可以从提交新建DNA库的返回参数中获取。 |
| UserData | String | 否 | example data | 用户自定义数据,支持中英文、数字等,最大长度128个字节。 |
| FileIds | String | 否 | 41e6536e4f2250e2e9bf26cdea19**** | 需要删除的文件ID,用半角逗号(,)分隔,一次最多删除200个。可以从查询DNA库文件列表的返回参数中获取。 |
| PrimaryKeys | String | 否 | 24e0fba7188fae707e146esa54**** | 需要删除的文件PrimaryKey,用半角逗号(,)分隔,一次最多删除200个。可以从查询DNA库文件列表的返回参数中获取。 说明 此参数当前仅支持华北2(北京)、华东1(杭州)、华东2(上海)地域使用。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | D127C68E-F1A1-4CE5-A874-8FF724881A12 | 请求ID。 |
| JobId | String | 39f8e0bc005e4f309379701645f4**** | DNA文件删除作业ID。 |
示例
请求示例
http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=SubmitFpFileDeleteJob
&PipelineId=ed450ea0bfbd41e29f80a401fb4d****
&FpDBId=88c6ca184c0e432bbf5b665e2a15****
&UserData=example data
&FileIds=41e6536e4f2250e2e9bf26cdea19****
&PrimaryKeys=24e0fba7188fae707e146esa54****
&<公共请求参数>
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SubmitFpFileDeleteJobResponse>
<RequestId>D127C68E-F1A1-4CE5-A874-8FF724881A12</RequestId>
<JobId>39f8e0bc005e4f309379701645f4****</JobId>
</SubmitFpFileDeleteJobResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "D127C68E-F1A1-4CE5-A874-8FF724881A12",
"JobId" : "39f8e0bc005e4f309379701645f4****"
}
错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter.DBNotExist | The DNA database does not exist. | 指纹数据库不存在 |
访问错误中心查看更多错误码。