检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开源知识库 开源知识库提供已治理的开源软件数据资产信息,包含元数据信息、漏洞信息、依赖信息等内容。 操作步骤 登录开源治理服务控制台。 在左侧导航栏,单击“开源知识库”。 单击“开源知识库”页面搜索框左侧,在下拉框中选择“软件”或“组件”,在搜索框中输入对应名称,支持模糊搜索,单
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
调用说明 开源治理服务提供了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。 父主题: 附录
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
相关术语说明 开源(open source) 即开放一类技术或一种产品的源代码,源数据,源资产,可以是各行业的技术或产品,其范畴涵盖文化、产业、法律、技术等多个社会维度。 开源软件(open source software) 允许用户直接访问源代码,通过开源许可协议将其复制、修改、再发布的权利向公众开放的计算机软件。
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,开源治理服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 开源治理服务的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 devsecurity
添加源码成分分析任务 提供对源码的全面分析功能,通过解压获取源码包中所有待分析源码文件,基于源码特征识别技术,获得相关被测对象的开源软件清单和潜在风险清单,并输出一份专业的分析报告。 用户只需要上传代码文件或关联代码仓库提交扫描任务,服务即可输出详尽专业的测试报告。 前提条件 已获取管理控制台的登录账号与密码。
管理源码成分分析任务 操作场景 该任务指导用户通过开源治理服务查找、删除或停止源码成分分析任务。 前提条件 已获取管理控制台的登录账号与密码。 已添加任务。 查看任务 登录开源治理服务控制台。 在左侧导航栏,单击“软件成分分析 > 源码成分分析”。 在“源码成分分析”页面,查看成
获取任务状态 功能介绍 根据任务ID获取任务状态 URI GET /v1/{project_id}/sbc/task/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2
查看源码成分分析扫描详情 该任务指导用户通过开源治理服务查看源码成分分析扫描结果。 前提条件 已获取管理控制台的登录账号与密码。 已执行扫描任务。 操作步骤 登录开源治理服务控制台。 在左侧导航栏,单击“软件成分分析 > 源码成分分析”。 在“源码成分分析”页面,可看到全部添加过
下载报告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 请求参数
获取用户信息 功能介绍 获取用户信息 URI GET /v1/{project_id}/sbc/user/info 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2 Query参数
上传分片文件 功能介绍 上传分片文件 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
获取组件漏洞映射表 功能介绍 获取组件漏洞映射表信息 URI GET /v1/{project_id}/sbc/vuln/map/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32
创建上传分片文件任务 功能介绍 创建上传分片文件任务 URI POST /v1/{project_id}/sbc/task/multipart/create 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32
结束上传分片文件任务 功能介绍 结束上传分片文件任务 URI POST /v1/{project_id}/sbc/task/multipart/notify 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32