# 查询最新的检查报告并刷新 - RefreshPortalServiceJobResult #### 功能介绍 当请求中的task_id不为空时，刷新最近一次检查成功的版本级任务的检查报告并返回刷新结果。 当请求中的task_id为空时，刷新job_id对应的执行记录的检查报告并返回刷新结果。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck:task:getReport | Read | task \* | - | - | - | | codeartscheck:task:getReport | Read | - | codeartscheck:ProjectId | - | - | #### URI PUT /v1/jobs/{job_id}/result/refresh 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | job_id | 是 | String | **参数解释：** 执行记录ID，即每一次执行版本级或门禁级扫描的唯一ID，主要用于查询门禁级任务。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_id | 否 | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | | async | 否 | String | **参数解释：** 是否同步刷新，同步刷新时会顺便返回刷新后的结果；异步刷新时在后台刷新，不返回刷新结果。 **约束限制：** true/false。 **取值范围：** true: 异步刷新时在后台刷新，不返回刷新结果。 false: 同步刷新时会顺便返回刷新后的结果。 **默认取值：** true。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释：** 响应状态。 **取值范围：** success：成功 failed：失败 | | httpStatus | Integer | **参数解释：** 响应状态码。 **取值范围：** 不涉及。 | | result | [JobReportInfo] object | **参数解释：** 最新的检查报告。 | 表5JobReportInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | CODE_SIZE | Integer | **参数解释：** 代码行数。 **取值范围：** 大于等于0。 | | COMFIRM | Integer | **参数解释：** 已确认的问题数。 **取值范围：** 大于等于0。 | | CRITICAL | Integer | **参数解释：** 严重问题数。 **取值范围：** 大于等于0。 | | DELAYSTATUS_COUNT | Integer | **参数解释：** 延迟上线问题数。 **取值范围：** 大于等于0。 | | FATAL | Integer | **参数解释：** 致命问题数。 **取值范围：** 大于等于0。 | | FILE_TOTAL | Integer | **参数解释：** 文件数。 **取值范围：** 大于等于0。 | | FIX | Integer | **参数解释：** 已解决问题数。 **取值范围：** 大于等于0。 | | GENERAL | Integer | **参数解释：** 一般问题数。 **取值范围：** 大于等于0。 | | IGNORE | Integer | **参数解释：** 已忽略问题数。 **取值范围：** 大于等于0。 | | NEW | Integer | **参数解释：** 新问题数。 **取值范围：** 大于等于0。 | | PROMPT | Integer | **参数解释：** 提示问题数。 **取值范围：** 大于等于0。 | | REPORT_URL | String | **参数解释：** 报告链接。 **取值范围：** 不涉及。 | | RESOLVED | Integer | **参数解释：** 已解决问题数。 **取值范围：** 大于等于0。 | | STANDARD_DISMISSED | Integer | **参数解释：** 正式问题忽略数。 **取值范围：** 大于等于0。 | | STANDARD_FIXED | Integer | **参数解释：** 正式问题修复数。 **取值范围：** 大于等于0。 | | STANDARD_NEW | Integer | **参数解释：** 正式问题数。 **取值范围：** 大于等于0。 | | TOOL_LIST | Array of strings | **参数解释：** 使用到的工具列表。 **取值范围：** 不涉及。 | | UCC_NBNC | Integer | **参数解释：** NBNC代码行数。 **取值范围：** 大于等于0。 | | UNRESOLVED | Integer | **参数解释：** 未解决的问题数。 **取值范围：** 大于等于0。 | | UNRESOLVED_ADD | Integer | **参数解释：** 新增未解决的问题数。 **取值范围：** 大于等于0。 | | critical | Integer | **参数解释：** 致命问题数。 **取值范围：** 大于等于0。 | | major | Integer | **参数解释：** 严重问题数。 **取值范围：** 大于等于0。 | | minor | Integer | **参数解释：** 一般问题数。 **取值范围：** 大于等于0。 | | suggestion | Integer | **参数解释：** 提示问题数。 **取值范围：** 大于等于0。 | | delay_critical | Integer | **参数解释：** 延迟致命问题数。 **取值范围：** 大于等于0。 | | delay_major | Integer | **参数解释：** 延迟严重问题数。 **取值范围：** 大于等于0。 | | delay_minor | Integer | **参数解释：** 延迟一般问题数。 **取值范围：** 大于等于0。 | | delay_suggestion | Integer | **参数解释：** 延迟提示问题数。 **取值范围：** 大于等于0。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 查询最新的检查报告并刷新。 ``` PUT https://{endpoint}/v1/jobs/e5470ceb4d0440f198b56974xxxxxxxx/result/refresh?task_id=&async=false ``` #### 响应示例 **状态码：200** 请求成功! ``` { "httpStatus" : "OK", "result" : { "CODE_SIZE" : 991, "COMFIRM" : 0, "CRITICAL" : 4, "DELAYSTATUS_COUNT" : 0, "FATAL" : 0, "FILE_TOTAL" : 3, "FIX" : 0, "GENERAL" : 108, "IGNORE" : 0, "NEW" : 122, "PROMPT" : 10, "REPORT_URL" : "https://devcloud.example.com/codechecknew/project/40a381e7abf944bdbc5d6865xxxxxxxx/codecheck/task/green/e2acda04fab44eb991b9f28cxxxxxxxx/detail", "RESOLVED" : 0, "STANDARD_DISMISSED" : 0, "STANDARD_FIXED" : 0, "STANDARD_NEW" : 122, "TOOL_LIST" : [ "fixbotengine-cxx", "clangtidy", "codemars" ], "UCC_NBNC" : 991, "UNRESOLVED" : 122, "UNRESOLVED_ADD" : 122, "critical" : 0, "delay_critical" : 0, "delay_major" : 0, "delay_minor" : 0, "delay_suggestion" : 0, "major" : 4, "minor" : 108, "suggestion" : 10 }, "status" : "success" } ``` **状态码：400** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功! | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。