任务配置检查参数
功能介绍
任务配置检查参数
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/tasks/{task_id}/config-parameters
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID |
task_id |
是 |
String |
任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
设置媒体类型和编码格式 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
check_id |
是 |
Integer |
检查工具ID,参数已废弃 |
ruleset_id |
是 |
String |
规则集ID,可以通过查询任务的已选规则集列表接口获取 |
language |
是 |
String |
规则集语言 |
status |
是 |
String |
off:关闭,on:开启,参数已废弃 |
task_check_settings |
是 |
Array of TaskCheckSettingsItem objects |
检查参数信息 |
响应参数
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
任务配置检查参:检查参数的语言类型为csharp,状态为on
POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/config-parameters { "check_id" : 11, "ruleset_id" : "b113bxxxxxxxx5738bee86ecxxxxxxxx", "language" : "csharp", "status" : "on", "task_check_settings" : [ { "cfg_key" : "csharpCompileTool", "status" : "on", "cfg_value" : "msbuild" } ] }
响应示例
状态码: 200
Request succeeded!
null
状态码: 400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "网络繁忙,请稍后再试" }
状态码: 401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }
SDK代码示例
SDK代码示例如下。
任务配置检查参:检查参数的语言类型为csharp,状态为on
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 59 60 61 62 63 |
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 ListTaskParameterSolution { 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(); ListTaskParameterRequest request = new ListTaskParameterRequest(); request.withProjectId("{project_id}"); request.withTaskId("{task_id}"); ConfigTaskParameterBody body = new ConfigTaskParameterBody(); List<TaskCheckSettingsItem> listbodyTaskCheckSettings = new ArrayList<>(); listbodyTaskCheckSettings.add( new TaskCheckSettingsItem() .withCfgKey("csharpCompileTool") .withStatus("on") .withCfgValue("msbuild") ); body.withTaskCheckSettings(listbodyTaskCheckSettings); body.withStatus("on"); body.withLanguage("csharp"); body.withRulesetId("b113bxxxxxxxx5738bee86ecxxxxxxxx"); body.withCheckId(11); request.withBody(body); try { ListTaskParameterResponse response = client.listTaskParameter(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()); } } } |
任务配置检查参:检查参数的语言类型为csharp,状态为on
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 |
# 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 = ListTaskParameterRequest() request.project_id = "{project_id}" request.task_id = "{task_id}" listTaskCheckSettingsbody = [ TaskCheckSettingsItem( cfg_key="csharpCompileTool", status="on", cfg_value="msbuild" ) ] request.body = ConfigTaskParameterBody( task_check_settings=listTaskCheckSettingsbody, status="on", language="csharp", ruleset_id="b113bxxxxxxxx5738bee86ecxxxxxxxx", check_id=11 ) response = client.list_task_parameter(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
任务配置检查参:检查参数的语言类型为csharp,状态为on
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 |
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.ListTaskParameterRequest{} request.ProjectId = "{project_id}" request.TaskId = "{task_id}" cfgValueTaskCheckSettings:= "msbuild" var listTaskCheckSettingsbody = []model.TaskCheckSettingsItem{ { CfgKey: "csharpCompileTool", Status: "on", CfgValue: &cfgValueTaskCheckSettings, }, } request.Body = &model.ConfigTaskParameterBody{ TaskCheckSettings: listTaskCheckSettingsbody, Status: "on", Language: "csharp", RulesetId: "b113bxxxxxxxx5738bee86ecxxxxxxxx", CheckId: int32(11), } response, err := client.ListTaskParameter(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 |
错误码
请参见错误码。