# 修改任务规则集 - UpdateTaskRuleset #### 功能介绍 修改代码检查任务的规则集配置，支持设置规则集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 /v2/tasks/{task_id}/ruleset 表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\]的字符。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | \[数组元素\] | 是 | Array of [UpdateTaskRulesetItem] objects | **参数解释：** 规则集信息。 **约束限制：** 不涉及。 | 表4UpdateTaskRulesetItem | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | language | 是 | String | **参数解释：** 检查语言，支持的语言请关注服务更新特性文档。 **约束限制:** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | rule_set_id | 是 | String | **参数解释：** 规则集ID。 **约束限制:** 长度为\[1\~32\]个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | if_use | 是 | String | **参数解释：** 是否启用。 **约束限制:** 不涉及。 **取值范围：** - 0：不启用。 - 1：启用。 **默认取值：** 不涉及。 | | status | 是 | String | **参数解释：** 新/老数据。 **约束限制:** 不涉及。 **取值范围：** 1 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 请求成功! **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 修改任务的规则集：规则集的语言类型为cpp，规则设置ID根据实际显示，规则状态为1。 ``` PUT https://{endpoint}/v2/tasks/{task_id}/ruleset [ { "language" : "cpp", "rule_set_id" : "7be4cfxxxxxxxxfd8d07077cxxxxxxxx", "if_use" : "1", "status" : "1" } ] ``` #### 响应示例 **状态码：200** 请求成功! ``` null ``` **状态码：400** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 修改任务的规则集：规则集的语言类型为cpp，规则设置ID根据实际显示，规则状态为1。 ``` 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 UpdateTaskRulesetSolution { 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("")) .build(); UpdateTaskRulesetRequest request = new UpdateTaskRulesetRequest(); request.withTaskId("{task_id}"); List listbodyUpdateTaskRuleset = new ArrayList<>(); listbodyUpdateTaskRuleset.add( new UpdateTaskRulesetItem() .withLanguage("cpp") .withRuleSetId("7be4cfxxxxxxxxfd8d07077cxxxxxxxx") .withIfUse("1") .withStatus("1") ); request.withBody(listbodyUpdateTaskRuleset); try { UpdateTaskRulesetResponse response = client.updateTaskRuleset(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()); } } } ``` - [Python] 修改任务的规则集：规则集的语言类型为cpp，规则设置ID根据实际显示，规则状态为1。 ``` # 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("")) \ .build() try: request = UpdateTaskRulesetRequest() request.task_id = "{task_id}" listUpdateTaskRulesetbody = [ UpdateTaskRulesetItem( language="cpp", rule_set_id="7be4cfxxxxxxxxfd8d07077cxxxxxxxx", if_use="1", status="1" ) ] request.body = listUpdateTaskRulesetbody response = client.update_task_ruleset(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 修改任务的规则集：规则集的语言类型为cpp，规则设置ID根据实际显示，规则状态为1。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codecheck.CodeCheckClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codecheck.NewCodeCheckClient(hcClient) request := &model.UpdateTaskRulesetRequest{} request.TaskId = "{task_id}" var listUpdateTaskRulesetbody = []model.UpdateTaskRulesetItem{ { Language: "cpp", RuleSetId: "7be4cfxxxxxxxxfd8d07077cxxxxxxxx", IfUse: "1", Status: "1", }, } request.Body = &listUpdateTaskRulesetbody response, err := client.UpdateTaskRuleset(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeCheck/sdk?api=UpdateTaskRuleset)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功! | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。