检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
勾选指定文件路径时,则该指定路径下的文件将排除检查。 在“忽略的文件集合”区域,勾选无需进行检查的文件路径。设置完成后,执行代码检查任务,将按照设置排除选中的文件路径执行检查。 勾选的忽略文件对需要编译的文件和不需要编译的文件均生效。 不需要编译的文件:勾选忽略文件后,被忽略的文件不参与检查。
Repo代码仓库中的代码质量 在代码开发过程中,编程人员能力和代码风格不一致,会影响代码的可阅读性和可维护性,例如代码注释要求。或者在某个平台/行业的代码编写要求比较特殊等一列问题,可通过使用代码检查服务检查代码质量。 本示例为您演示检查CodeArts Repo代码仓库中的代码质量,帮助您快速建立对代码检查服务的整体印象。
String 仓库有权限的用户名 access_token 否 String 仓库有权限的用户token endpoint_id 否 String 仓库有权限的用户endpointId inc_config 否 IncConfigV2 object 增量检查相关的参数 enable_fossbot
单击代码检查任务名称。 在“代码检查详情”页面,默认显示“概览”页签,单击可以通过分支筛选代码仓进行代码检查。 设置筛选条件后,单击“开始检查”,等待代码检查任务执行完成。 再次单击代码检查任务所在行的执行检查任务时,检查的代码分支会自动变更为创建检查任务时设置的默认分支。
数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-1
信息请参见产品介绍。 终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,服务的终端节点信息可参考地区和终端节点。 代码检查的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 代码检查的终端节点 区域名称 区域 终端节点(Endpoint)
将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订规则概览。 如果您已开启“自动续费”功能,为避免继续产生费用,请在自动续费扣款日(默认为到期前7日)之前关闭自动续费。
单次检查支持扫描的问题数量 一个代码检查任务支持扫描的问题数量最多为300000。 租户自定义规则集数(个) 租户可以自定义的规则集数最大为1000。 租户创建代码检查任务数(个) 租户下可以创建的总任务数最大为50000。 单次代码检查最大时长 12小时。 支持的自定义规则数量 最多10条。
查询审计日志 云审计服务是安全解决方案中专业的日志审计服务,记录了CodeArts Check的相关操作事件,方便您日后的查询、审计和回溯。 支持审计日志的操作 表1 云审计服务支持CodeArts Check服务操作 操作名称 资源类型 事件名称 创建代码检查任务 task create
String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数 参数 是否必选
String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数 参数 是否必选
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数
想继续使用,需要在指定的时间内为代码检查服务续费。 代码检查服务在到期前续费成功,代码检查服务可正常使用,且代码检查任务的运行不受影响。代码检查服务到期后的状态说明,请参见到期后影响。 续费相关的功能 代码检查服务续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费
参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer
rule_ids String 规则集包含的规则id,每条规则都有1个唯一的规则id is_default String 是否是该语言默认规则集,0不是,1是 is_devcloud_project_default String 是否是项目下该语言默认规则集,0不是,1是 is_default_template
代码检查是否通过是由设置的质量门禁值判断,门禁值设置请参考配置代码检查任务质量门禁。 问题数:检查出来的代码质量问题数。 延迟上线问题数:由于检查引擎的能力提升,出现的新问题数。 未解决新问题数:当前的代码检查结果中,未解决的问题个数。 已解决问题数:当前的代码检查结果中,已解决的问题个数 代码平均圈复杂度:代码的平均圈复杂度。
rule_ids String 规则集包含的规则id,每条规则都有1个唯一的规则id is_default String 是否是该语言默认规则集,0不是,1是 is_devcloud_project_default String 是否是项目下该语言默认规则集,0不是,1是 is_default_template
计费价格请以代码检查价格详情实际计算中的价格为准。 资源扩展的计费项请参见计费项。 计费周期 代码检查服务计费周期是根据您购买的时长来确定的(以GMT+08:00时间为准)。一个计费周期的起点是您开通或续费套餐的时间(精确到秒),终点则是到期日的23:59:59。 例如,如果您在2023/03/08
task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String