历史扫描结果查询
功能介绍
查询某个任务在时间范围内每次扫描各个问题级别的问题数量。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/tasks/{task_id}/checkrecord
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_id |
是 |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 32位项目ID。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 页码,类似page_num的作用。 约束限制: 不涉及。 取值范围: 0-999999 |
limit |
否 |
Integer |
参数解释: 每页数量,类似page_size的作用。 约束限制: 不涉及。 取值范围: 1-1000 |
start_time |
否 |
String |
参数解释: 任务检查开始时间。使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2020-09-25T12:05:00Z。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 2000-01-01T00:00:00Z |
end_time |
否 |
String |
参数解释: 任务检查结束时间。使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2020-09-25T12:05:00Z。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 当前时间。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
Array of CheckRecordDataInfo objects |
参数解释: 每次扫描的各个问题级别的问题数量。 取值范围: 不涉及。 |
total |
Integer |
参数解释: 扫描次数总数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
参数解释: 执行ID,来自代码检查执行任务接口的返回值,每次执行代码检查任务都有1个唯一的执行ID。版本级不传,门禁级必传。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
check_time |
String |
参数解释: 检查任务执行开始时间,使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。 取值范围: 不涉及。 |
check_end_time |
String |
参数解释: 检查任务执行结束时间,使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。 取值范围: 不涉及。 |
issue_counts |
CheckRecordIssueCountsInfo object |
参数解释: 各个问题级别的问题数量。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
critical |
Integer |
参数解释: 致命问题数量。 取值范围: 不涉及。 |
serious |
Integer |
参数解释: 严重问题数量。 取值范围: 不涉及。 |
normal |
Integer |
参数解释: 一般问题数量。 取值范围: 不涉及。 |
prompt |
Integer |
参数解释: 提示问题数量。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
在ID为e04b357xxxxx5ed832xxxxxx的项目下,查询ID为2b31ed520xxxxxxebedb6e57xxxxxxxx的任务在UTC时间2025-06-01T00:00:00Z到2025-06-10T00:00:00Z之间的所有扫描结果数据
GET https://{endpoint}/v2/363540xxxxxxxx5105099944xxxxxxxx/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/checkrecord?start_time=2025-06-01T00:00:00Z&end_time=2025-06-10T00:00:00Z
响应示例
状态码:200
Request succeeded!
{ "total" : 100, "data" : [ { "check_time" : "2023-11-29T05:28:41Z", "check_end_time" : "2023-11-29T05:30:38Z", "job_id" : "84xxxxxxxxxxxxxxxxxxxxxxxxxxxx6f", "issue_counts" : { "critical" : 0, "serious" : 1, "normal" : 2, "prompt" : 3 } }, { "check_time" : "2023-09-29T05:28:41Z", "check_end_time" : "2023-09-29T05:30:38Z", "job_id" : "a4xxxxxxxxxxxxxxxxxxxxxxxxxxxxb1", "issue_counts" : { "critical" : 0, "serious" : 1, "normal" : 2, "prompt" : 3 } } ] }
状态码:400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "网络繁忙,请稍后再试" }
状态码:401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codecheck.v2.region.CodeCheckRegion; import com.huaweicloud.sdk.codecheck.v2.*; import com.huaweicloud.sdk.codecheck.v2.model.*; public class CheckRecordSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeCheckClient client = CodeCheckClient.newBuilder() .withCredential(auth) .withRegion(CodeCheckRegion.valueOf("<YOUR REGION>")) .build(); CheckRecordRequest request = new CheckRecordRequest(); request.withProjectId("{project_id}"); request.withTaskId("{task_id}"); try { CheckRecordResponse response = client.checkRecord(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodecheck.v2.region.codecheck_region import CodeCheckRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodecheck.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeCheckClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeCheckRegion.value_of("<YOUR REGION>")) \ .build() try: request = CheckRecordRequest() request.project_id = "{project_id}" request.task_id = "{task_id}" response = client.check_record(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codecheck "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codecheck/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codecheck/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codecheck/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codecheck.NewCodeCheckClient( codecheck.CodeCheckClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CheckRecordRequest{} request.ProjectId = "{project_id}" request.TaskId = "{task_id}" response, err := client.CheckRecord(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Request succeeded! |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。