Creating a Check Task
Function
Create a check task but do not execute it.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/task
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum: 1 Maximum: 100000 |
Content-Type |
Yes |
String |
Media type and encoding format. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
check_type |
No |
Array of strings |
Check type, in array format. The default value is source. |
git_url |
Yes |
String |
Repository address |
git_branch |
Yes |
String |
Repository Branch |
language |
Yes |
Array of strings |
Check language. The value is in array format and can be cpp,java,js,python,php,css,html,go,typescript,csharp. |
rule_sets |
No |
Array of RuleSetV2 objects |
Specifying a Rule Set |
task_type |
No |
String |
Check type. The value can be full or inc. full indicates full check, and inc indicates MR check. |
username |
No |
String |
Name of the user who has the permission to access the repository. |
access_token |
No |
String |
Token of a user who has permission on the repository. |
endpoint_id |
No |
String |
Specifies the endpoint ID of the user who has the repository permission. |
inc_config |
No |
IncConfigV2 object |
Parameters related to incremental check |
enable_fossbot |
No |
Boolean |
Indicates whether to enable fossbot check. By default, fossbot check is disabled. |
resource_pool_id |
No |
String |
Specifies the resource pool ID, which can be obtained from the resource pool management page. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ruleset_id |
No |
String |
Rule set ID, which needs to be obtained from the web page. |
language |
Yes |
String |
Check the language. cpp,java,js,python,php,css,html,go,typescript,csharp is supported. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
parent_task_id |
No |
String |
ID of the parent task to be associated. This parameter is required for pipeline creation or MR creation. |
git_source_branch |
No |
String |
Incrementally check code source branches. |
git_target_branch |
No |
String |
Incrementally check the code target branch. |
merge_id |
No |
String |
Unique MR ID |
event_type |
No |
String |
Webhook triggering event type. The options are merge_request and push_request. |
action |
No |
String |
Webhook event status, which can be open, close, or update. |
title |
No |
String |
MR Title |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Specifies the check task ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Codes |
error_msg |
String |
Description |
Example Requests
Create a check task. The check type of the check task is source, the corresponding code repository URL is displayed based on the site requirements, the code repository branch is master, and the language type is cpp.
POST https://{endpoint}/v2/{project_id}/task { "check_type" : [ "source" ], "git_url" : "git@code*****************958.git", "git_branch" : "master", "language" : [ "cpp", "js" ] }
Example Responses
Status code: 200
Request succeeded!
{ "task_id" : "d161fd0**********cb3c1d6a783e" }
Status code: 400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "The network is busy. Please try again later." }
Status code: 401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "The authentication information has expired." }
SDK Sample Code
The SDK sample code is as follows.
Create a check task. The check type of the check task is source, the corresponding code repository URL is displayed based on the site requirements, the code repository branch is master, and the language type is cpp.
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 |
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 CreateTaskSolution { 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(); CreateTaskRequest request = new CreateTaskRequest(); CreateTaskRequestV2 body = new CreateTaskRequestV2(); List<String> listbodyLanguage = new ArrayList<>(); listbodyLanguage.add("cpp"); listbodyLanguage.add("js"); List<String> listbodyCheckType = new ArrayList<>(); listbodyCheckType.add("source"); body.withLanguage(listbodyLanguage); body.withGitBranch("master"); body.withGitUrl("git@code*****************958.git"); body.withCheckType(listbodyCheckType); request.withBody(body); try { CreateTaskResponse response = client.createTask(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()); } } } |
Create a check task. The check type of the check task is source, the corresponding code repository URL is displayed based on the site requirements, the code repository branch is master, and the language type is cpp.
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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CodeCheckClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeCheckRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateTaskRequest() listLanguagebody = [ "cpp", "js" ] listCheckTypebody = [ "source" ] request.body = CreateTaskRequestV2( language=listLanguagebody, git_branch="master", git_url="git@code*****************958.git", check_type=listCheckTypebody ) response = client.create_task(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create a check task. The check type of the check task is source, the corresponding code repository URL is displayed based on the site requirements, the code repository branch is master, and the language type is cpp.
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 |
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.CreateTaskRequest{} var listLanguagebody = []string{ "cpp", "js", } var listCheckTypebody = []string{ "source", } request.Body = &model.CreateTaskRequestV2{ Language: listLanguagebody, GitBranch: "master", GitUrl: "git@code*****************958.git", CheckType: &listCheckTypebody, } response, err := client.CreateTask(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