创建二进制成分分析扫描任务 - CreateTask
功能介绍
创建二进制成分分析扫描任务，支持用户通过上传文件或提供文件URL来创建扫描任务，并根据用户提供的参数配置任务的扫描引擎和类型。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
codeartsgovernance::createBinaryTask |
Write |
- |
- |
- |
- |
URI
POST /v1/{project_id}/sbc/task/start
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 用户项目ID，获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 32位项目ID。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
|
Content-Type |
是 |
String |
参数解释： 编码格式。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： application/json：传任何值，接口返回值均为json格式。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
file_path |
否 |
String |
参数解释： 文件路径。 约束限制： 不涉及。 取值范围： 字符串长度不少于1，不超过128。 默认取值： 不涉及。 |
|
file_name |
否 |
String |
参数解释： 文件名称。 约束限制： 不涉及。 取值范围： 字符串长度不少于1，不超过128。 默认取值： 不涉及。 |
|
file_size |
否 |
Long |
参数解释： 文件大小，单位是字节（Byte）。 约束限制： 不涉及。 取值范围： 0-5368709120。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
String |
参数解释： 任务ID。 取值范围： 字符串长度不小于0，不大于256。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：429
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 错误描述。 取值范围： 不涉及。 |
请求示例
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",
"file_size" : 100
}
响应示例
状态码：200
Request succeeded!
{
"data" : {
"id" : "00000000-0000-0000-0000-000000000000"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
429 |
Too Many Requests |
错误码
请参见错误码。
