# 修改任务忽略文件 - UpdateIgnoreFiles #### 功能介绍 根据任务ID、文件（目录）路径、文件（目录）名、文件忽略状态修改任务的忽略文件配置，文件或目录在设置成忽略状态后不会对其进行扫描。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck:task:update | Write | task \* | - | - | - | | codeartscheck:task:update | Write | - | codeartscheck:ProjectId | - | - | #### URI PUT /v4/task/{task_id}/ignore-files 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_id | 是 | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | | Content-Type | 是 | String | **参数解释：** 编码格式。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** application/json，传任何值，接口返回值均为json格式。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | nodes | 否 | Array of [UpdateIgnoreFilesRepoTreeNode] objects | **参数解释:** 需要更新忽略状态的文件树的节点的列表。 **约束限制：** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | 表4UpdateIgnoreFilesRepoTreeNode | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释:** 节点名。 **约束限制：** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | | file_path | 否 | String | **参数解释:** 文件路径。 **约束限制：** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | | is_leaf | 否 | Boolean | **参数解释:** 是否为叶子节点。 **约束限制：** 不涉及。 **取值范围:** 不涉及。 **默认取值：** 不涉及。 | | checkbox_status | 否 | String | **参数解释:** 忽略文件勾选状态。 **约束限制：** 不涉及。 **取值范围:** - unchecked：未勾选。 - all：勾选。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释：** 更新成功时返回"更新忽略文件成功"。 **取值范围：** 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 修改任务ID为10155df661744d1f98f0055f1236702d的任务的忽略文件配置，路径为CppDemo/CppDemoView.h的文件设置为未勾选（即不忽略），路径为CppDemo/KnightMath的文件夹设置为勾选（即忽略）。 ``` PUT https://{endpoint}/v4/task/10155df661744d1f98f0055f1236702d/ignore-files { "nodes" : [ { "file_path" : "CppDemo/CppDemoView.h", "name" : "CppDemoView.h", "is_leaf" : true, "checkbox_status" : "unchecked" }, { "file_path" : "CppDemo/KnightMath", "name" : "KnightMath", "is_leaf" : false, "checkbox_status" : "all" } ] } ``` #### 响应示例 **状态码：200** 请求成功! ``` { "result" : "更新忽略文件成功" } ``` **状态码：400** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功! | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。