检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 流水线接口说明 分类 接口 二进制成分分析 包括创建上传分片文件任务、上传分片文件、结束上传分片文件任务等接口。
如何调用API 构造请求 认证鉴权 返回结果
API 二进制成分分析
获取漏洞信息对外接口 功能介绍 获取漏洞信息对外接口信息 URI GET /v1/{project_id}/sbc/vuln/info 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32
列出漏洞信息对外接口 功能介绍 列出漏洞信息对外接口信息 URI GET /v1/{project_id}/sbc/vuln/info/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32
列出漏洞信息对外接口 功能介绍 列出漏洞信息对外接口信息 URI POST /v1/{project_id}/sbc/vuln/info/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987
获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,开源治理服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 开源治理服务的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 devsecurity
对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体
种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token
获取密钥和信息泄露统计数据 功能介绍 根据任务ID获取密钥和信息泄露的统计数据 URI GET /v1/{project_id}/sbc/task/summary/infoleak 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
获取密钥和信息泄露统计数据 获取安全编译选项统计数据 获取安全配置统计数据 创建报告PDF 查看报告PDF状态 下载报告PDF 创建报告Excel 查看报告Excel状态 下载报告Excel 获取组件漏洞映射表 获取漏洞信息对外接口 列出漏洞信息对外接口 列出漏洞信息对外接口 获取用户信息
其中,error_code表示错误码,error_msg表示错误描述信息。 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 429 SG.XXXX0001 Too
获取任务状态 功能介绍 根据任务ID获取任务状态 URI GET /v1/{project_id}/sbc/task/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2
删除任务 功能介绍 根据任务ID删除任务 URI DELETE /v1/{project_id}/sbc/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2 Query参数
创建报告Excel 功能介绍 根据任务ID创建报告Excel URI POST /v1/{project_id}/sbc/report/excel/create 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32
创建报告PDF 功能介绍 根据任务ID创建报告PDF URI POST /v1/{project_id}/sbc/report/pdf/create 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32
停止任务 功能介绍 根据任务ID停止任务 URI POST /v1/{project_id}/sbc/task/stop 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2 Query参数