Configuring Check Parameters for a Task
Function
This API is used to update the rule set check parameters of a task. You can set the rule set ID, rule set language, and rule set compilation configuration.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
|
Action |
Access Level |
Resource Type (*: required) |
Condition Key |
Alias |
Dependencies |
|---|---|---|---|---|---|
|
codeartscheck:task:update |
Write |
task * |
- |
- |
- |
|
- |
codeartscheck:ProjectId |
URI
POST /v2/{project_id}/tasks/{task_id}/config-parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition : 32-character project UUID. Obtain it by calling the API used to query the project list. Constraints: N/A Value range: 1 to 32 characters. Default value: N/A |
|
task_id |
Yes |
String |
Definition : Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID. Constraints: N/A Value range: 1 to 128 characters. Default value: N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition : User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token. Constraints: N/A Value range: 1–100,000 characters. Default value: N/A |
|
Content-Type |
No |
String |
Definition: Media type and encoding format. Constraints: N/A Value range: N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
check_id |
Yes |
Integer |
Definition This parameter is deprecated. You can set it to 0. Constraints N/A Range N/A Default Value N/A |
|
ruleset_id |
Yes |
String |
Definition : Rule set ID. Obtain the ID by calling the API used to obtain the rule set list. Constraints: N/A Value range: 1 to 32 characters. Default value: N/A |
|
language |
Yes |
String |
Definition : Rule set language. Obtain the language by calling the API used to obtain the rule set list. Constraints: N/A Value range: Must match the language of the rule set specified by ruleset_id. Default value: N/A |
|
status |
Yes |
String |
Definition Compilation switch status of the current rule set. Constraints N/A Range Default Value N/A |
|
task_check_settings |
Yes |
Array of TaskCheckSettingsItem objects |
Definition Array of compilation configuration details of the current rule set. Check the compilation configurations of the current rule set on the web page. Configure multiple parameters if any. Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
cfg_key |
Yes |
String |
Definition Compilation condition key of a rule set. Constraints N/A Range Default Value N/A |
|
status |
Yes |
String |
Definition: Enabling status of the current check parameter key. Set this parameter to on. Constraints: N/A Value range: on. Default value: N/A |
|
cfg_value |
No |
String |
Definition Compilation condition value of a rule set. Constraints N/A Range Obtain the options from the web page > Check task > Settings > Rule Sets > Configuration. Default Value N/A |
Response Parameters
Status code: 200
Request succeeded!
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Definition: Error code. Value range: N/A |
|
error_msg |
String |
Definition: Error message. Value range: N/A |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Definition: Error code. Value range: N/A |
|
error_msg |
String |
Definition: Error message. Value range: N/A |
Example Requests
Configure compilation parameters. Set the language to java and status to on.
POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/config-parameters
{
"check_id" : 0,
"ruleset_id" : "b113bxxxxxxxx5738bee86ecxxxxxxxx",
"language" : "java",
"status" : "on",
"task_check_settings" : [ {
"cfg_value" : "maven",
"cfg_key" : "compileTool",
"status" : "on"
}, {
"cfg_value" : "maven3.8.5-jdk17",
"cfg_key" : "buildToolVersion",
"status" : "on"
}, {
"cfg_value" : "mvn clean package -Dmaven.test.skip=true -U -e -X -B",
"cfg_key" : "compileScriptCmd",
"status" : "on"
} ]
}
Example Responses
Status code: 200
Request succeeded!
null
Status code: 400
Bad Request
{
"error_code" : "CC.xxxxxxxx.400",
"error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}
Status code: 401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "Authentication information expired."
}
SDK Sample Code
The SDK sample code is as follows.
Configure compilation parameters. Set the language to java and status to 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 64 65 66 67 68 69 70 71 72 73 74 75 |
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("compileTool") .withStatus("on") .withCfgValue("maven") ); listbodyTaskCheckSettings.add( new TaskCheckSettingsItem() .withCfgKey("buildToolVersion") .withStatus("on") .withCfgValue("maven3.8.5-jdk17") ); listbodyTaskCheckSettings.add( new TaskCheckSettingsItem() .withCfgKey("compileScriptCmd") .withStatus("on") .withCfgValue("mvn clean package -Dmaven.test.skip=true -U -e -X -B") ); body.withTaskCheckSettings(listbodyTaskCheckSettings); body.withStatus("on"); body.withLanguage("java"); body.withRulesetId("b113bxxxxxxxx5738bee86ecxxxxxxxx"); body.withCheckId(0); 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()); } } } |
Configure compilation parameters. Set the language to java and status to 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 |
# 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="compileTool", status="on", cfg_value="maven" ), TaskCheckSettingsItem( cfg_key="buildToolVersion", status="on", cfg_value="maven3.8.5-jdk17" ), TaskCheckSettingsItem( cfg_key="compileScriptCmd", status="on", cfg_value="mvn clean package -Dmaven.test.skip=true -U -e -X -B" ) ] request.body = ConfigTaskParameterBody( task_check_settings=listTaskCheckSettingsbody, status="on", language="java", ruleset_id="b113bxxxxxxxx5738bee86ecxxxxxxxx", check_id=0 ) 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) |
Configure compilation parameters. Set the language to java and status to 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 64 |
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:= "maven" cfgValueTaskCheckSettings1:= "maven3.8.5-jdk17" cfgValueTaskCheckSettings2:= "mvn clean package -Dmaven.test.skip=true -U -e -X -B" var listTaskCheckSettingsbody = []model.TaskCheckSettingsItem{ { CfgKey: "compileTool", Status: "on", CfgValue: &cfgValueTaskCheckSettings, }, { CfgKey: "buildToolVersion", Status: "on", CfgValue: &cfgValueTaskCheckSettings1, }, { CfgKey: "compileScriptCmd", Status: "on", CfgValue: &cfgValueTaskCheckSettings2, }, } request.Body = &model.ConfigTaskParameterBody{ TaskCheckSettings: listTaskCheckSettingsbody, Status: "on", Language: "java", RulesetId: "b113bxxxxxxxx5738bee86ecxxxxxxxx", CheckId: int32(0), } response, err := client.ListTaskParameter(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot