查询编译前执行的检查前置命令 - ShowPortalServicePreCheckScript
功能介绍
根据任务ID查询任务的检查前置命令,检查前置命令在编译之前执行,方便用户搭建自定义的扫描环境。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
codeartscheck:task:get | Read | task * | - | - | - |
- | codeartscheck:ProjectId |
URI
GET /v1/tasks/{task_id}/pre-check-script
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
task_id | 是 | String | 参数解释: 任务ID,即新建检查任务接口的返回值,每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制: 不涉及。 取值范围: 长度为[1~128]个字符。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
httpStatus | String | 参数解释: HTTP响应状态。 取值范围:
|
result | 参数解释: 检查前置命令,编译之前执行脚本。 取值范围: 不涉及。 | |
status | String | 参数解释: 接口响应状态。 取值范围:
|
参数 | 参数类型 | 描述 |
|---|---|---|
preCheckScript | String | 参数解释: 检查前置命令,编译之前执行脚本。 取值范围: 不涉及。 |
region | String | 参数解释: 华为云地域。 取值范围: 不涉及。 |
taskGroupId | String | 参数解释: 任务分组的ID。 取值范围: 字符串长度不少于1,不超过128。 |
updateTime | String | 参数解释: 上次更新时间,时间格式为UTC格式,格式为yyyy-MM-ddTHH:mm:ssZ,例如"2025-11-28T06:55:41Z"。 取值范围: 不涉及。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
查询任务ID为685ddb216a12457593569a753e4d5573的任务的前置检查命令。
GET https://{endpoint}/v1/tasks/685ddb216a12457593569a753e4d5573/pre-check-script 响应示例
状态码:200
Request succeeded!
{
"httpStatus" : "OK",
"result" : {
"preCheckScript" : "echo hello",
"region" : "cn-north-7",
"taskGroupId" : "e6d91c451b7d46f28b768b8a32501a3d",
"updateTime" : "2025-09-15T08:17:26Z"
},
"status" : "success"
} 状态码:400
Bad Request
{
"error_code" : "CC.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
} 状态码:401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
} 状态码
状态码 | 描述 |
|---|---|
200 | Request succeeded! |
400 | Bad Request |
401 | Unauthorized |
错误码
请参见错误码。

