Updated on 2026-08-10 GMT+08:00

Querying the Pre-check Commands Executed Before Compilation

Function

This API is used to query the pre-check commands of a task based on the task ID. The pre-check commands are executed before compilation, helping users set up their own environment.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartscheck:task:get	Read	task *	-	-	-
codeartscheck:task:get	Read	-	codeartscheck:ProjectId	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	Definition Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID. Constraints N/A Range 1 to 32 characters. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token. Constraints N/A Range The length is the value of [1-100000]. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
httpStatus	String	Definition: HTTP response status. Value range: OK: The request has been successfully processed, and the server returns the requested resource or operation result. ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations). INTERNAL_SERVER_ERROR: internal API exception. BAD_REQUEST: abnormal parameter verification.
result	ShowPortalServicePreCheckScriptResult object	Definition Pre-check commands, which are executed before the compilation.
status	String	Definition: API response status. Value range: success: successful response. error: response failed.

**Table 4** ShowPortalServicePreCheckScriptResult
Parameter	Type	Description
preCheckScript	String	Definition: Pre-check commands, which are executed before the compilation. Range: N/A
region	String	Definition: Huawei Cloud region. Range: N/A
taskGroupId	String	Definition: Task group ID. Value range: 1 to 128 characters.
updateTime	String	Definition: Time (UTC) when a task was last updated. Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z. Value range: N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Example Requests

Query the pre-check commands of the task whose ID is 685ddb216a12457593569a753e4d5573.

GET https://{endpoint}/v1/tasks/685ddb216a12457593569a753e4d5573/pre-check-script

Example Responses

Status code: 200

Request succeeded.

{
  "httpStatus" : "OK",
  "result" : {
    "preCheckScript" : "echo hello",
    "region" : "cn-north-7",
    "taskGroupId" : "e6d91c451b7d46f28b768b8a32501a3d",
    "updateTime" : "2025-09-15T08:17:26Z"
  },
  "status" : "success"
}

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code	Description
200	Request succeeded.
400	A request error occurred.
401	The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management