检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用说明 开源治理服务提供了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”,则表示请求成功。 响应消息头 对应请求
图3描述了包年/包月开源治理服务各个阶段的状态。购买后,在计费周期内资源正常运行,此阶段为有效期;资源到期而未续费时,将陆续进入宽限期和保留期。 图3 包年/包月开源治理服务生命周期 到期预警 包年/包月开源治理服务在到期前第15天内,系统将在服务使用界面向用户推送到期预警消息。 当开源治理服务套餐资
API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
计费模式概述 开源治理服务提供按需套餐包和包年/包月计费模式,以满足您的不同用户需求。 按需套餐包,一种预付费模式,即先付费再使用,按照扫描成功的次数结算。 包年/包月,一种预付费模式,即先付费再使用,按照订单的购买周期进行结算。购买时长不同优惠力度不同。 表1 二进制成分分析计费模式说明
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,开源治理服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 开源治理服务的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 devsecurity
CodeArts Governance最佳实践汇总 本文汇总了基于开源治理服务(CodeArts Governance)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户了解CodeArts Governance的使用方法。 表1 CodeArts Governance最佳实践一览表
删除任务 功能介绍 根据任务ID删除任务 URI DELETE /v1/{project_id}/sbc/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32 表2 Query参数
停止任务 功能介绍 根据任务ID停止任务 URI POST /v1/{project_id}/sbc/task/stop 表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 表2
获取漏洞信息对外接口 功能介绍 获取漏洞信息对外接口信息 URI GET /v1/{project_id}/sbc/vuln/info 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32
查看报告Excel状态 功能介绍 根据任务ID查看报告Excel状态 URI GET /v1/{project_id}/sbc/report/excel/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id
查看报告PDF状态 功能介绍 根据任务ID查看报告PDF状态 URI GET /v1/{project_id}/sbc/report/pdf/status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32
获取安全配置统计数据 功能介绍 根据任务ID获取安全配置的统计数据 URI GET /v1/{project_id}/sbc/task/summary/secconfig 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id
获取开源漏洞分析报告 功能介绍 根据任务ID获取开源漏洞分析的报告 URI GET /v1/{project_id}/sbc/task/report/opensource 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id
列出漏洞信息对外接口 功能介绍 列出漏洞信息对外接口信息 URI POST /v1/{project_id}/sbc/vuln/info/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id 最小长度:32 最大长度:32
获取开源漏洞分析统计数据 功能介绍 根据任务ID获取开源漏洞分析的统计数据 URI GET /v1/{project_id}/sbc/task/summary/opensource 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户project_id