检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
状态码 正常 返回值 说明 200 请求成功。 异常 状态码 编码 错误码说明 400 Bad Request 服务器不能或不会处理该请求。 401 Unauthorized 当前请求需要用户验证。 403 Forbidden 服务器拒绝执行该请求。 404 Not Found 服务器无法找到被请求的资源
查询审计日志 云审计服务是安全解决方案中专业的日志审计服务,记录了CodeArts Governance的相关操作事件,方便您日后的查询、审计和回溯。 支持审计日志的操作 表1 云审计服务支持CodeArts Governance操作列表 操作名称 资源类型 事件名称 创建二进制成分分析任务
概述 开源治理服务(CodeArts Governance)是针对软件研发提供的一站式开源软件治理服务,凝聚华为在开源治理上的优秀实践经验,提供开源软件元数据及软件成分分析、恶意代码检测等能力,从合法合规、网络安全、供应安全等维度消减开源软件使用风险,助力企业更加安全、更加高效地使用开源软件
如何调用API 构造请求 认证鉴权 返回结果
开源知识库 开源知识库提供已治理的开源软件数据资产信息,包含元数据信息、漏洞信息、依赖信息等内容。 操作步骤 登录开源治理服务控制台。 在左侧导航栏,单击“开源知识库”。 单击“开源知识库”页面搜索框左侧,在下拉框中选择“软件”或“组件”,在搜索框中输入对应名称,支持模糊搜索,单击
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
与其他服务的关系 与代码检查服务的关系 开源治理服务中的代码检查功能由独立的代码检查(CodeArts Check)云服务提供,用户可以通过超链接跳转至代码检查的页面进行使用。当前代码检查是CodeArts云服务下的子服务,用户需开通CodeArts服务方可使用。 与漏洞管理服务的关系
文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第六次正式发布,本次变更说明如下: 错误码更新。 2024-03-13 第五次正式发布,本次变更说明如下: 下线移动应用安全接口。 上线二进制成分分析接口。 2024
控制台总览 开源治理服务(CodeArts Governance)是覆盖软件研发阶段的安全、合规检测产品集合,提供一站式的原子化的安全服务和专家咨询服务的入口,满足企业客户、检测机构针对于研发阶段安全和漏洞检测的需求。 本节为您介绍开源治理服务控制台登录方式及菜单页。 登录开源治理服务控制台
源码成分分析 添加源码成分分析任务 管理源码成分分析任务 查看源码成分分析扫描详情
调用说明 开源治理服务提供了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”,则表示请求成功。 响应消息头 对应请求消息头
基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需要使用一个
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
二进制成分分析 添加二进制成分分析任务 管理二进制成分分析任务 查看二进制成分分析扫描详情 下载二进制成分分析扫描报告 相关术语说明
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,开源治理服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 开源治理服务的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 devsecurity.cn-north