检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时
身份认证与访问控制 身份认证 用户访问代码检查服务的方式有多种,包括代码检查用户界面、API、SDK,无论访问方式封装成何种形式,其本质都是通过代码检查提供的REST风格的API接口进行请求。 代码检查的接口需要经过认证请求后才可以访问成功。代码检查支持两种认证方式: Token
TypeScript任务检查失败,日志显示404 问题现象 TypeScript任务检查失败,日志显示404。 处理方法 请检查上传的项目文件中是否包含“package-lock.json”文件。 如果包含,则删除“package-lock.json”文件,重新Push代码进行检查。
请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。
配置代码检查任务高级选项 配置新问题起始时间 在每个任务的基础上可以设置新问题起始时间。起始时间设置之后要重新扫描,问题的发现时间大于设置时间将被划分为新问题。如果没有设置起始时间,连续两次的检查结果对比,新增的就是新问题数。 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。
请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码:
请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码:
图1 代码检查任务ID 创建访问凭证AK和SK 登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 单击“访问密钥”。 单击“新增访问密钥”,弹出“新增访问密钥”页面。 输入该访问密钥的描述信息。 单击“确定”,下载访问密钥。 为防止访问密钥泄露,建议您将其保存到安全的位置。
CodeArts Check的通知设置支持系统项目级、服务项目级和任务级,您可以根据实际需求,设置代码检查任务事件类型的通知方式。入口分别如下: 服务项目级:进入项目详情页面,选择“代码 > 代码检查 > 配置中心 > 通知管理”。 任务级:进入代码检查详情页面,选择“设置 > 通知管理”。本节以任务级通知设置为例介绍操作步骤。
旧版代码检查计费方式如何收费? 本章节仅供老用户参考。 代码检查服务依赖需求管理服务,开通前请先开通需求管理服务。 服务的开通需要区分区域,因此开通前注意选择自己需要开通的区域。 服务开通后,需注意创建的资源也分区域。 例如,在“华北-北京四”中创建了“项目A”,在下次查看“项目
请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码:
提供多维度质量统计报表,如质量门禁和代码健康度徽标等。 精准 精确定位缺陷,提供修复指导。 支持用户自定义检查规则集,精准检查用户关注缺陷。 全面 支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTML/PHP/LUA/RUST/Shell/KOTLI
码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头 响应消息体 响应
息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。
提示“单击链接登录后获取配置数据(…)”等相关信息,单击提示下连接“Login config”跳转到登录页面登录。 若已登录,“Setting”页面提示“设置页面已移动到底部CodeArts Check > Setting面板”,单击提示下方链接打开底部Setting面板查看配置。
统一到期日是指通过续费将包年/包月实例的到期日统一固定为一个月的某一天。 如果您购买的代码检查服务套餐、资源扩展的到期日不同,可以将到期日统一设置到固定一个日期,便于日常管理和续费。 图1展示了用户将两个不同时间到期的资源,同时续费一个月,并设置“统一到期日”后的效果对比。 图1
支持主流开发语言 支持主流开发语言,内置9000+检查规则,便于用户开箱即用 代码检查服务支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTML/PHP/LUA/RUST/Shell/KOTLIN/SCALA/ArkTS/SQ