更新时间:2024-11-28 GMT+08:00

修改任务规则集

功能介绍

修改任务规则集。

调用方法

请参见如何调用API

URI

PUT /v2/tasks/{task_id}/ruleset

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

设置媒体类型和编码格式

X-Auth-Token

String

用户Token

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

Array of UpdateTaskRulesetItem objects

修改规则集信息

表4 UpdateTaskRulesetItem

参数

是否必选

参数类型

描述

language

String

规则集语言

rule_set_id

String

规则集ID,通过调用ListTaskRuleset接口,根据响应参数中的template_id获得

if_use

String

任务语言和规则集的关系是否启用,1是启用,0是未启用

status

String

新/老数据表示,默认1

响应参数

状态码: 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

Request succeeded!

null

状态码: 400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙,请稍后再试"
}

状态码: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

SDK代码示例

SDK代码示例如下。

修改任务的规则集:规则集的语言类型为cpp,规则设置ID根据实际显示,规则状态为1

 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
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("<YOUR REGION>"))
                .build();
        UpdateTaskRulesetRequest request = new UpdateTaskRulesetRequest();
        request.withTaskId("{task_id}");
        List<UpdateTaskRulesetItem> 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());
        }
    }
}

修改任务的规则集:规则集的语言类型为cpp,规则设置ID根据实际显示,规则状态为1

 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
# 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 = 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)

修改任务的规则集:规则集的语言类型为cpp,规则设置ID根据实际显示,规则状态为1

 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
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.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的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码