执行检查任务
功能介绍
执行检查任务。
调用方法
请参见如何调用API。
URI
POST /v2/tasks/{task_id}/run
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_id |
是 |
String |
任务ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 |
Content-Type |
是 |
String |
设置媒体类型和编码格式 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
username |
否 |
String |
该任务对应临时仓库有权限的用户名 |
access_token |
否 |
String |
该任务对应临时仓库有权限的用户token |
git_url |
否 |
String |
该任务对应的临时仓库地址 |
git_branch |
否 |
String |
该任务对应的临时仓库分支 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
exec_id |
String |
执行id |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
执行检查任务:执行任务对应代码仓URL根据实际显示,代码仓分支为master,用户名根据实际显示
POST https://{endpoint}/v2/tasks/{taskid}/run { "git_url" : "http://github.xxxxxxxx.git", "git_branch" : "master", "username" : "test", "access_token" : "xLD56xxxxxxxxxJF3Sdxxxx" }
响应示例
状态码: 200
Request succeeded!
{ "exec_id" : "d163535d0*******81d6a7654443e" }
状态码: 400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "网络繁忙,请稍后再试" }
状态码: 401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "认证信息过期" }
SDK代码示例
SDK代码示例如下。
执行检查任务:执行任务对应代码仓URL根据实际显示,代码仓分支为master,用户名根据实际显示
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 |
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.*; public class RunTaskSolution { 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(); RunTaskRequest request = new RunTaskRequest(); RunRequestV2 body = new RunRequestV2(); body.withGitBranch("master"); body.withGitUrl("http://github.xxxxxxxx.git"); body.withAccessToken("xLD56xxxxxxxxxJF3Sdxxxx"); body.withUsername("test"); request.withBody(body); try { RunTaskResponse response = client.runTask(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()); } } } |
执行检查任务:执行任务对应代码仓URL根据实际显示,代码仓分支为master,用户名根据实际显示
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 |
# 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 = RunTaskRequest() request.body = RunRequestV2( git_branch="master", git_url="http://github.xxxxxxxx.git", access_token="xLD56xxxxxxxxxJF3Sdxxxx", username="test" ) response = client.run_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) |
执行检查任务:执行任务对应代码仓URL根据实际显示,代码仓分支为master,用户名根据实际显示
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.RunTaskRequest{} gitBranchRunRequestV2:= "master" gitUrlRunRequestV2:= "http://github.xxxxxxxx.git" accessTokenRunRequestV2:= "xLD56xxxxxxxxxJF3Sdxxxx" usernameRunRequestV2:= "test" request.Body = &model.RunRequestV2{ GitBranch: &gitBranchRunRequestV2, GitUrl: &gitUrlRunRequestV2, AccessToken: &accessTokenRunRequestV2, Username: &usernameRunRequestV2, } response, err := client.RunTask(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 |
错误码
请参见错误码。