CreateFileDetection - 创建文件送检任务--高级网络威胁检测系统-火山引擎

文档中心

立即注册

导航

CreateFileDetection - 创建文件送检任务

最近更新时间：2024.10.22 15:26:07首次发布时间：2024.10.21 16:29:15

创建文件送检任务，调用后文件将会被文件检测引擎扫描检测。

注意事项

仅支持单个文件送检。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=CreateFileDetection&Version=2024-07-30

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CreateFileDetection	要执行的操作，取值：CreateFileDetection。
Version	String	是	2024-07-30	API的版本，取值：2024-07-30。
SignURL	String	是	https://xxx.tos-cn-beijing.volces.com/ac94......9ebb1ad797f755a.elf?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Content-Sha256=UNSIGNED-PAYLOAD&X-Tos-Credential=AKTP23yz1Tm3mw0f3ljI%2F20240718%2Fcn-boe%2Ftos%2Frequest&X-Tos-Date=20240718T094357Z&X-Tos-Expires=3600&X-Tos-SignedHeaders=host&X-Tos-Security-Token=nChZVYW........8lwM1VB.CioKFlp0clhwbuaNHE8mrfJ3cdJL1awQ0cfjtAYY4ePjt.....oEcm9vdEIDdG9zUhNjb********F90ZXN0WAFgAQ.zLaEFrD....q.....RTV9wlgjPkRBGRdaTCs-EKBVh4FA2bQpS3T_EbjlzdqnrG2g&X-Tos-Signature=38ab15ca......9adf070f....4ed501	被检测的文件在 TOS 的预签名 URL 链接。该链接可以在 TOS 平台的文件详情中生成。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
QueryKey	String	d41d8cd98*************8ecf8427e	创建送检任务后，返回的 Key 值，该值用于查询文件的详细检测结果。

请求示例

POST /?Action=CreateFileDetection&Version=2024-07-30 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241022T063953Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241022/cn-beijing/nta/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "SignURL": "https://xxx.tos-cn-beijing.volces.com/ac94......9ebb1ad797f755a.elf?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Content-Sha256=UNSIGNED-PAYLOAD&X-Tos-Credential=AKTP23yz1Tm3mw0f3ljI%2F20240718%2Fcn-boe%2Ftos%2Frequest&X-Tos-Date=20240718T094357Z&X-Tos-Expires=3600&X-Tos-SignedHeaders=host&X-Tos-Security-Token=nChZVYW........8lwM1VB.CioKFlp0clhwbuaNHE8mrfJ3cdJL1awQ0cfjtAYY4ePjt.....oEcm9vdEIDdG9zUhNjb********F90ZXN0WAFgAQ.zLaEFrD....q.....RTV9wlgjPkRBGRdaTCs-EKBVh4FA2bQpS3T_EbjlzdqnrG2g&X-Tos-Signature=38ab15ca......9adf070f....4ed501"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202407191******19418100E3FC",
    "Action": "CreateFileDetection",
    "Version": "2023-07-20",
    "Service": "nta",
    "Region": "cn-beijing"
  },
  "Result": {
    "QueryKey": "d41d8cd98*************8ecf8427e"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	参数不合法。
400	MissingParameter	The required parameter %s is missing.	请求缺少接口必填参数。
400	QuotaExceeded	%s has exceeded the quota. example: The memory size of the specified disk has exceeded the quota.	资源使用超出上限。
403	AccessDenied	You are not authorized to perform this action.	没有相应的接口执行权限。
500	InternalError	The request has failed due to an unknown error.	请求失败，内部错误，一般是接口崩溃或者出现未知错误。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	请求失败，一般在服务短暂不可用时发生。