新建检查任务
功能介绍
新建检查任务但是不执行。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/task
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 |
Content-Type |
是 |
String |
设置媒体类型和编码格式 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
check_type |
否 |
Array of strings |
检查类型,数组格式,默认为source |
git_url |
是 |
String |
仓库地址 |
git_branch |
是 |
String |
仓库分支 |
language |
是 |
Array of strings |
检查语言,数组格式,支持cpp,java,js,python,php,css,html,go,typescript,csharp |
rule_sets |
否 |
Array of RuleSetV2 objects |
指定规则集 |
task_type |
否 |
String |
检查类型,支持full/inc两种类型,full表示全量检查,inc表示mr检查 |
username |
否 |
String |
仓库有权限的用户名 |
access_token |
否 |
String |
仓库有权限的用户token |
endpoint_id |
否 |
String |
仓库有权限的用户endpointId |
inc_config |
否 |
IncConfigV2 object |
增量检查相关的参数 |
enable_fossbot |
否 |
Boolean |
是否打开fossbot检查,默认不开 |
resource_pool_id |
否 |
String |
资源池id,可以从资源池管理页面获取 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ruleset_id |
否 |
String |
规则集id,需要从web界面获取 |
language |
是 |
String |
检查语言,支持cpp,java,js,python,php,css,html,go,typescript,csharp |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
parent_task_id |
否 |
String |
需要关联的父任务ID,流水线创建或MR创建任务需要该参数 |
git_source_branch |
否 |
String |
增量检查代码源分支 |
git_target_branch |
否 |
String |
增量检查代码目标分支 |
merge_id |
否 |
String |
MR唯一标识ID |
event_type |
否 |
String |
webhook触发事件类型,merge_request/push_request |
action |
否 |
String |
webhook事件状态,open/close/update |
title |
否 |
String |
MR标题 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
检查任务id |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
新建检查任务:检查任务的检查类型为source,对应代码仓URL根据实际情况显示,代码仓分支为master,语言类型为cpp
POST https://{endpoint}/v2/{project_id}/task { "check_type" : [ "source" ], "git_url" : "git@code*****************958.git", "git_branch" : "master", "language" : [ "cpp", "js" ] }
响应示例
状态码: 200
Request succeeded!
{ "task_id" : "d161fd0**********cb3c1d6a783e" }
状态码: 400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "网络繁忙,请稍后再试" }
状态码: 401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }
SDK代码示例
SDK代码示例如下。
新建检查任务:检查任务的检查类型为source,对应代码仓URL根据实际情况显示,代码仓分支为master,语言类型为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()); } } } |
新建检查任务:检查任务的检查类型为source,对应代码仓URL根据实际情况显示,代码仓分支为master,语言类型为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) |
新建检查任务:检查任务的检查类型为source,对应代码仓URL根据实际情况显示,代码仓分支为master,语言类型为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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Request succeeded! |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。