检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题。
与其他服务的关系 与代码检查服务的关系 开源治理服务中的代码检查功能由独立的代码检查(CodeArts Check)云服务提供,用户可以通过超链接跳转至代码检查的页面进行使用。当前代码检查是CodeArts云服务下的子服务,用户需开通CodeArts服务方可使用。 与漏洞管理服务的关系
调用说明 开源治理服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 您可以在API Explorer中调用API,查看API请求和返回结果。此外,API Explorer会
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,开源治理服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 开源治理服务的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 devsecurity
二进制成分分析 添加二进制成分分析任务 管理二进制成分分析任务 查看二进制成分分析扫描详情 下载二进制成分分析扫描报告 相关术语说明
二进制成分分析 创建上传分片文件任务 上传分片文件 结束上传分片文件任务 创建二进制成分分析扫描任务 获取任务状态 停止任务 删除任务 获取开源漏洞分析报告 获取开源漏洞分析统计数据 获取密钥和信息泄露统计数据 获取安全编译选项统计数据 获取安全配置统计数据 创建报告PDF 查看报告PDF状态
二进制成分分析类 成分分析的扫描对象是什么? 成分分析的主要扫描规格有哪些? 成分分析的扫描原理是什么,主要识别哪些风险? 成分分析的开源软件风险如何分析? 成分分析的安全编译选项类问题如何分析? 成分分析的安全配置类问题如何分析? 成分分析的信息泄露问题如何分析? 组件版本为什么没有被识别出来或识别错误?
管理源码成分分析任务 操作场景 该任务指导用户通过开源治理服务查找、删除或停止源码成分分析任务。 前提条件 已获取管理控制台的登录账号与密码。 已添加任务。 查看任务 登录开源治理服务控制台。 在左侧导航栏,单击“软件成分分析 > 源码成分分析”。 在“源码成分分析”页面,查看成
相关术语说明 开源(open source) 即开放一类技术或一种产品的源代码,源数据,源资产,可以是各行业的技术或产品,其范畴涵盖文化、产业、法律、技术等多个社会维度。 开源软件(open source software) 允许用户直接访问源代码,通过开源许可协议将其复制、修改、再发布的权利向公众开放的计算机软件。
上传分片文件 功能介绍 上传分片文件 URI POST /v1/{project_id}/sbc/task/multipart 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 请求参数
下载报告PDF 功能介绍 根据任务ID下载报告PDF URI GET /v1/{project_id}/sbc/report/pdf 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2
快速创建一个二进制成分分析任务 开源治理服务(CodeArts Governance)是针对软件研发提供的一站式开源软件治理服务,凝聚华为在开源治理上的优秀实践经验,提供开源软件元数据及软件成分分析、恶意代码检测等能力,从合法合规、网络安全、供应安全等维度消减开源软件使用风险,助
下载报告Excel 功能介绍 根据任务ID下载报告Excel URI GET /v1/{project_id}/sbc/report/excel 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32
获取套餐额度信息 功能介绍 获取套餐额度信息 URI GET /v1/{project_id}/sbc/quota/info 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 请求参数
获取任务状态 功能介绍 根据任务ID获取任务状态 URI GET /v1/{project_id}/sbc/task/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2
获取用户信息 功能介绍 获取用户信息 URI GET /v1/{project_id}/sbc/user/info 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2 Query参数