文档首页/ 开源治理服务 CodeArts Governance/ API参考/ API/ 二进制成分分析/ 创建二进制成分分析扫描任务
更新时间：2024-03-12 GMT+08:00
查看PDF
分享

创建二进制成分分析扫描任务

功能介绍

创建二进制成分分析扫描任务，需先将待扫描包上传至文件服务器临时上传地址中

URI

POST /v1/{project_id}/sbc/task/start

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户project_id

最小长度：32

最大长度：32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

Content-Type

是

String
表3 请求Body参数

参数

是否必选

参数类型

描述

file_path

否

String

文件路径

最小长度：1

最大长度：128

file_name

否

String

文件名称

最小长度：0

最大长度：128

file_size

否

Integer

文件名称

最小值：0

最大值：5368709120

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

String

任务ID

最小长度：0

最大长度：256

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 429

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

请求示例

POST https://{endpoint}/v1/{project_id}/sbc/task/start

{
  "file_path" : "/secbinarycheck/pre-signed/2024/01/01/00000000-0000-0000-0000-000000000000",
  "file_name" : "test"
}

响应示例

状态码： 200

创建任务响应对象

{
  "data" : {
    "id" : "00000000-0000-0000-0000-000000000000"
  }
}

状态码

状态码

描述

200

创建任务响应对象

400

错误响应体

401

错误响应体

429

错误响应体

错误码

请参见错误码。

父主题： 二进制成分分析

相关文档