检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 流水线接口说明 分类 接口 二进制成分分析 包括创建上传分片文件任务、上传分片文件、结束上传分片文件任务等接口。
2023年9月 序号 功能 功能描述 阶段 相关文档 1 开源治理(CodeArts Governance)服务首次发布 开源治理服务(CodeArts Governance)是针对软件研发提供的一站式开源软件治理服务,凝聚华为在开源治理上的优秀实践经验,提供开源软件元数据及软件成分分析
您可以使用本文档提供的API对开源治理服务进行相关操作,如:新建上传分片文件任务、文件分片上传等。支持的全部操作请参见API概览。 在调用开源治理服务的API之前,请确保已经充分了解开源治理服务的相关概念,详细信息请参见产品介绍。 父主题: 使用前必读
签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。 父主题: 如何调用API
操作步骤 登录开源治理服务控制台。 在左侧导航栏,单击“开源知识库”。
调用说明 开源治理服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 您可以在API Explorer中调用API,查看API请求和返回结果。
获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
开源软件使用风险评估 二进制成分分析服务提供开放API,并与CI/CD融合,完善DevSecOps安全能力。 开源/第三方软件引入评估 二进制成分分析服务提供页面和开放API,提供风险快速评估能力。
操作步骤 登录开源治理服务控制台。 在左侧导航栏,单击“开源许可证”。 在“开源许可证”页面,可看到许可证列表,内容包含许可证名称、集成风险、许可证描述和风险分析以及重置操作。 图1 开源许可证 单击许可证的风险等级下拉框可以自定义对应许可证的风险等级。
请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 请求方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。
CodeArts Governance最佳实践汇总 本文汇总了基于开源治理服务(CodeArts Governance)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户了解CodeArts Governance的使用方法。
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,开源治理服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。
二进制成分分析 添加二进制成分分析任务 管理二进制成分分析任务 查看二进制成分分析扫描详情 下载二进制成分分析扫描报告 相关术语说明
停止任务 功能介绍 根据任务ID停止任务 URI POST /v1/{project_id}/sbc/task/stop 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2 Query
二进制成分分析 创建上传分片文件任务 上传分片文件 结束上传分片文件任务 创建二进制成分分析扫描任务 获取任务状态 停止任务 删除任务 获取开源漏洞分析报告 获取开源漏洞分析统计数据 获取密钥和信息泄露统计数据 获取安全编译选项统计数据 获取安全配置统计数据 创建报告PDF 查看报告
二进制成分分析类 成分分析的扫描对象是什么? 成分分析的主要扫描规格有哪些? 成分分析的扫描原理是什么,主要识别哪些风险? 成分分析的开源软件风险如何分析? 成分分析的安全编译选项类问题如何分析? 成分分析的安全配置类问题如何分析? 成分分析的信息泄露问题如何分析? 组件版本为什么没有被识别出来或识别错误
删除任务 功能介绍 根据任务ID删除任务 URI DELETE /v1/{project_id}/sbc/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2 Query参数
下载报告PDF 功能介绍 根据任务ID下载报告PDF URI GET /v1/{project_id}/sbc/report/pdf 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表
选择“服务列表 > 开发与运维 > 开源治理服务”,进入开源治理服务管理控制台。 在左侧导航栏,单击“软件成分分析 > 二进制成分分析”。