Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Ignoring Directories for a Task
Updated on 2025-08-21 GMT+08:00

Ignoring Directories for a Task

Function

This API is used to specify directories to exclude in a task.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/tasks/{task_id}/config-ignorepath

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Unique 32-character UUID of a project. Obtain a UUID by calling the API forquerying projects.

Constraints

N/A

Range

32-character project ID.

Default Value

N/A

task_id

Yes

String

Definition

Task ID, returned by the API for creating a check task. Each CodeArts Check task, branch task, or incremental task generated through an API has a unique ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

1–100,000 characters

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ignore_path_settings

Yes

Array of IgnorePathSettingItem objects

Definition

List of nodes whose directories will be shielded.

Constraints

N/A

Table 4 IgnorePathSettingItem

Parameter

Mandatory

Type

Description

file_path

Yes

String

Definition

Directory or file path to be shielded.

Constraints

N/A

Range

N/A

Default Value

N/A

checkbox_status

Yes

String

Definition

Shielding status.

Constraints

N/A

Range

  • unchecked: Cancel shielding

  • all: Shield all

  • half: Shield some subdirectories and files in a directory

Default Value

N/A

Response Parameters

Status code: 200

Request succeeded!

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Ignore directories of a task: The file path is .LAST_RELEASE, and the check status is all.

POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/config-ignorepath

{
  "ignore_path_settings" : [ {
    "file_path" : ".LAST_RELEASE",
    "checkbox_status" : "all"
  } ]
}

Example Responses

Status code: 200

Request succeeded!

null

Status code: 400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "Network busy. Try again later."
}

Status code: 401

Unauthorized

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

SDK Sample Code

The SDK sample code is as follows.

Ignore directories of a task: The file path is .LAST_RELEASE, and the check status is all.

 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
48
49
50
51
52
53
54
55
56
57
58
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.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateIgnorePathSolution {

    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();
        UpdateIgnorePathRequest request = new UpdateIgnorePathRequest();
        request.withProjectId("{project_id}");
        request.withTaskId("{task_id}");
        UpdateIgnorePathRequestBody body = new UpdateIgnorePathRequestBody();
        List<IgnorePathSettingItem> listbodyIgnorePathSettings = new ArrayList<>();
        listbodyIgnorePathSettings.add(
            new IgnorePathSettingItem()
                .withFilePath(".LAST_RELEASE")
                .withCheckboxStatus("all")
        );
        body.withIgnorePathSettings(listbodyIgnorePathSettings);
        request.withBody(body);
        try {
            UpdateIgnorePathResponse response = client.updateIgnorePath(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());
        }
    }
}

Ignore directories of a task: The file path is .LAST_RELEASE, and the check status is all.

 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
# 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 = UpdateIgnorePathRequest()
        request.project_id = "{project_id}"
        request.task_id = "{task_id}"
        listIgnorePathSettingsbody = [
            IgnorePathSettingItem(
                file_path=".LAST_RELEASE",
                checkbox_status="all"
            )
        ]
        request.body = UpdateIgnorePathRequestBody(
            ignore_path_settings=listIgnorePathSettingsbody
        )
        response = client.update_ignore_path(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Ignore directories of a task: The file path is .LAST_RELEASE, and the check status is all.

 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
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.UpdateIgnorePathRequest{}
	request.ProjectId = "{project_id}"
	request.TaskId = "{task_id}"
	var listIgnorePathSettingsbody = []model.IgnorePathSettingItem{
        {
            FilePath: ".LAST_RELEASE",
            CheckboxStatus: "all",
        },
    }
	request.Body = &model.UpdateIgnorePathRequestBody{
		IgnorePathSettings: listIgnorePathSettingsbody,
	}
	response, err := client.UpdateIgnorePath(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.