检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题
什么是开源治理服务 开源治理服务(CodeArts Governance)是针对软件研发提供的一站式开源软件治理服务,凝聚华为在开源治理上的优秀实践经验,提供开源软件元数据及软件成分分析、恶意代码检测等能力,从合法合规、网络安全、供应安全等维度消减开源软件使用风险,助力企业更加安全
应用场景 二进制成分分析 二进制成分分析主要用于以下场景。 开源软件使用风险评估 二进制成分分析服务提供开放API,并与CI/CD融合,完善DevSecOps安全能力。 开源/第三方软件引入评估 二进制成分分析服务提供页面和开放API,提供风险快速评估能力。 源码成分分析 源码成分分析主要用于以下场景
开源许可证 操作场景 用户可以查看开源许可证的信息和自定义开源许可证的风险等级。 前提条件 已获取管理控制台的登录账号与密码。 操作步骤 登录开源治理服务控制台。 在左侧导航栏,单击“开源许可证”。 在“开源许可证”页面,可看到许可证列表,内容包含许可证名称、集成风险、许可证描述和风险分析以及重置操作
调用说明 开源治理服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 您可以在API Explorer中调用API,查看API请求和返回结果。此外,API Explorer会自动生成相应
获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
包年/包月 适用场景 适用于可预估资源使用周期的场景,价格比按需套餐包计费模式更优惠。对于长期使用者,推荐该方式。以下是一些适用于包年/包月计费模式的业务场景: 稳定业务需求:对于长期运行且资源需求相对稳定的业务,如企业业务系统等,包年/包月计费模式能提供较高的成本效益。 长期项目
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
与其他服务的关系 与代码检查服务的关系 开源治理服务中的代码检查功能由独立的代码检查(CodeArts Check)云服务提供,用户可以通过超链接跳转至代码检查的页面进行使用。当前代码检查是CodeArts云服务下的子服务,用户需开通CodeArts服务方可使用。 与漏洞管理服务的关系
基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员
按需套餐包 适用场景 按需套餐包适用于短期使用的场景。 适用计费项 表1 二进制成分分析按需套餐包适用计费项 计费项 说明 扫描成功的次数 二进制成分分析为每个华为云账号提供5次免费试用的机会,可以免费试用5次任务。免费试用扫描对象文件大小限制300MB,可体验所有检查项功能。 二进制成分分析按需套餐包按扫描成功的次数结算
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
计费模式概述 开源治理服务提供按需套餐包和包年/包月计费模式,以满足您的不同用户需求。 按需套餐包,一种预付费模式,即先付费再使用,按照扫描成功的次数结算。 包年/包月,一种预付费模式,即先付费再使用,按照订单的购买周期进行结算。购买时长不同优惠力度不同。 表1 二进制成分分析计费模式说明
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,开源治理服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 开源治理服务的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 devsecurity.cn-north
二进制成分分析 添加二进制成分分析任务 管理二进制成分分析任务 查看二进制成分分析扫描详情 下载二进制成分分析扫描报告 相关术语说明
如何减少开源治理服务配额? 购买开源治理服务或配额后不能减少配额,仅支持升级规格。 如果用户需要减少配额,需要等之前购买的套餐到期或者退订当前的包年/包月套餐后,重新购买。 父主题: 计费FAQ
二进制成分分析 创建上传分片文件任务 上传分片文件 结束上传分片文件任务 创建二进制成分分析扫描任务 获取任务状态 停止任务 删除任务 获取开源漏洞分析报告 获取开源漏洞分析统计数据 获取密钥和信息泄露统计数据 获取安全编译选项统计数据 获取安全配置统计数据 创建报告PDF 查看报告
管理源码成分分析任务 操作场景 该任务指导用户通过开源治理服务查找、删除或停止源码成分分析任务。 前提条件 已获取管理控制台的登录账号与密码。 已添加任务。 查看任务 登录开源治理服务控制台。 在左侧导航栏,单击“软件成分分析 > 源码成分分析”。 在“源码成分分析”页面,查看成分分析任务列表