文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 查询编译前执行的shell脚本
更新时间:2025-09-29 GMT+08:00
分享

查询编译前执行的shell脚本

功能介绍

查询编译前执行的shell脚本。

调用方法

请参见如何调用API

URI

GET /v1/tasks/{task_id}/pre-check-script

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

httpStatus

String

参数解释:

HTTP响应状态,接口响应成功时为"OK",接口响应失败时为其他HTTP状态码。如INTERNAL_SERVER_ERROR为接口内部异常,BAD_REQUEST是参数校验异常。

取值范围:

  • OK,接口响应成功。

  • ACCEPTED,接口响应成功。

  • INTERNAL_SERVER_ERROR,接口内部异常。

  • BAD_REQUEST,参数校验异常。

result

ShowPortalServicePreCheckScriptResult object

参数解释:

检查前置命令,编译之前执行脚本。

取值范围:

不涉及。

status

String

参数解释:

接口响应状态。

取值范围:

  • success,接口响应成功。

  • error,接口响应失败。

表3 ShowPortalServicePreCheckScriptResult

参数

参数类型

描述

preCheckScript

String

参数解释:

检查前置命令,编译之前执行脚本。

取值范围:

不涉及。

region

String

参数解释:

华为云地域。

取值范围:

不涉及。

taskGroupId

String

参数解释:

任务分组的id。

取值范围:

字符串长度不少于1,不超过128。

updateTime

String

参数解释:

上次更新时间,时间格式为utc格式。

取值范围:

不涉及。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表5 响应Body参数

参数

参数类型

描述

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.00000000",
  "error_msg" : "网络繁忙,请稍后再试"
}

状态码:401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档