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

Downloading Log Files

Function

This API is used to download log files in a ZIP package.

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/log-file

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
sub_job_id	Yes	String	Definition: ID of one or more subtasks contained in an execution. Constraints: N/A Value range: 32-character subtask ID. 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
-	File	Definition: Log files, which are compressed into a package. Value range: N/A

Status code: 400

**Table 4** 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 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

Example Requests

GET https://{endpoint}/v1/log-file?sub_job_id=a777ff00d3cf4d369d87066806aexxxx

Example Responses

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: Obtaining Check Logs