获取开源漏洞分析报告 - ShowOpenSourceReport
功能介绍
根据任务ID获取开源漏洞分析报告,返回包含漏洞数量、组件信息、漏洞详情等的报告数据。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| codeartsgovernance::getBinaryReportOpenSource | Read | - | - | - | - |
URI
GET /v1/{project_id}/sbc/task/report/opensource
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 用户项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 32位项目ID。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 是 | String | 参数解释: 任务ID,即“创建二进制成分分析扫描任务”的返回值,每个CodeArtsGovernance任务都有唯一的任务ID。 约束限制: 不涉及。 取值范围: 36位固定长度。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 编码格式。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: application/json:传任何值,接口返回值均为json格式。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | Object | 参数解释: 接口响应成功。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v1/{project_id}/sbc/task/report/opensource?id={id} 响应示例
状态码:200
Request succeeded!
-
{ "data" : { "components" : [ { "name" : "cglib", "version" : "3.3.0", "objects" : [ "cglib.jar" ], "extended_objects" : [ { "name" : "cglib.jar", "confidence" : "1.0", "sha1" : "c956b9f9708af5901e9cf05701e9b2b1c25027cc", "type" : "", "timestamp" : 1689215071, "full_path" : [ "cglib.jar" ], "matching_method" : "pom" } ], "vulns" : [ ], "licenses" : [ "Apache License V2.0" ], "object_num" : 1, "vuln_num" : 0, "display_priority" : "D", "display_lifecycle" : "" } ], "id" : "aacc1797-be8c-4b99-90fc-5513320d98d2", "status" : "R", "filename" : "cglib.jar", "sha1" : "c956b9f9708af5901e9cf05701e9b2b1c25027cc", "report" : "https://xxx", "creator" : "aa01075476d04508b7d3162e29dcd52d", "summary" : { "vuln_detail" : { "critical" : 0, "major" : 0, "high" : 0, "minor" : 0, "critical_remaining" : 0, "major_remaining" : 0, "high_remaining" : 0, "minor_remaining" : 0 }, "comp_detail" : { "no_known_vuln_comp" : 1, "vulnerable_comp" : 0 } }, "release_info" : { "vuln_database_version" : "2024-02-22", "plat_version" : "2.0" }, "start_time" : "2023-07-13 10:29:11", "end_time" : "2023-07-13 10:29:34" } }
状态码
| 状态码 | 描述 |
|---|---|
| 200 | Request succeeded! |
| 400 | Bad Request |
| 401 | Unauthorized |
| 429 | Too Many Requests |
错误码
请参见错误码。