# 查询日志 - ShowLog #### 功能介绍 查询代码检查日志，支持分页查询，由于后端会过滤敏感信息，所以返回行数会小于查询行数。 #### 调用方法 请参见[如何调用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:get | Read | task \* | - | - | - | | codeartscheck:task:get | Read | - | codeartscheck:ProjectId | - | - | #### URI GET /v1/console-log 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | job_id | 是 | String | **参数解释：** 1次执行可能包含1个或多个子任务，子任务对应的ID。 **约束限制：** 不涉及。 **取值范围：** 32位子任务ID。 **默认取值：** 不涉及。 | | start_offset | 否 | Long | **参数解释：** 查询日志的开始范围。 **约束限制：** 第1次调用时，应传0，后续调用时，应传此接口返回值result.startOffset的值。 **取值范围：** 0-9223372036854775807 **默认取值：** 0 | | end_offset | 否 | Long | **参数解释：** 查询日志的结束范围。 **约束限制：** 第1次调用时，应传0，后续调用时，应传此接口返回值result.endOffset的值。 **取值范围：** 0-9223372036854775807 **默认取值：** 0 | | size | 否 | Integer | **参数解释：** 单次查询日志的行数，为原生日志行数，返回时会进行过滤，行数会小于size。 **约束限制：** 不涉及。 **取值范围：** 0-1000 **默认取值：** 100 | | sort | 否 | String | **参数解释：** 查询顺序。 **约束限制：** 不涉及。 **取值范围：** - DESC,倒序查询。 - ASC，正序查询。 **默认取值：** DESC | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ShowLogResponse | String | 查询日志成功。 | 表4ShowLogResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | [ShowLogResponseResult] object | **参数解释：** 代码检查任务执行的日志信息。 **取值范围：** 不涉及。 | | error | [MainError] object | **参数解释：** 代码检查任务执行的报错信息。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 接口响应状态。 **取值范围：** - success：接口响应成功。 - error：接口响应失败。 | 表5ShowLogResponseResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | hasMore | Boolean | **参数解释：** 正序查询的标志，仅在正序查询时生效。 **取值范围：** - true，仍有后续日志。 - false，没有后续日志。 | | startOffset | Long | **参数解释：** 下次查询日志的开始范围，同时充当倒序查询的标志。 **取值范围：** 0-9223372036854775807，倒序查询时：为0表示没有后续日志，不为0表示仍有后续日志。 | | endOffset | Long | **参数解释：** 下次查询日志的结束范围。 **取值范围：** 0-9223372036854775807 | | log | String | **参数解释：** 日志内容。 **取值范围：** 不涉及。 | | location | String | **参数解释：** 暂无业务意义。 **取值范围：** jenkins。 | | override | Boolean | **参数解释：** 暂无业务意义。 **取值范围：** false、true. | 表6MainError | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | reason | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 | | message | String | **参数解释：** 错误信息。 **取值范围：** 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v1/console-log?size=300&sort=DESC&start_offset=0&end_offset=0&job_id=a777ff00d3cf4d369d87066806aexxxx ``` #### 响应示例 **状态码：200** 查询日志成功。 ``` { "result" : { "hasMore" : false, "startOffset" : 88961, "endOffset" : 176422, "log" : "[2025/09/23 14:10:07.623 GMT+08:00] [INFO] [CHECK_PARALLEL:analyze] : main-INFO org.pf4j.AbstractPluginManager.startPlugin(AbstractPluginManager.java:407) - Start plugin 'CmetricsPlugin@1.0.0'\n", "location" : "jenkins", "override" : true }, "error" : { }, "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)。