更新时间:2024-04-17 GMT+08:00

执行构建任务

功能介绍

执行构建任务,可传自定义参数

调用方法

请参见如何调用API

URI

POST /v3/jobs/build

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务接口获取 (响应消息头中X-Subject-Token的值)。 不支持租户全局token,请使用scope为project的region级token。

表2 请求Body参数

参数

是否必选

参数类型

描述

job_id

String

构建任务ID;编辑构建任务时,浏览器URL末尾的32位数字、字母组合的字符串

parameter

Array of ParameterItem objects

自定义参数

scm

Scm object

代码信息

表3 ParameterItem

参数

是否必选

参数类型

描述

name

String

参数名称

value

String

参数值

表4 Scm

参数

是否必选

参数类型

描述

build_tag

String

代码Tag

build_commit_id

String

代码提交ID

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

octopus_job_name

String

临时任务名称

actual_build_number

String

实际构建次数

daily_build_number

String

构建每日编号

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

执行任务ID为“f9d6c8466d614a9788e9a0acf6c15f46”,代码仓名称为“codeBranch”,代码仓分支为“master”的构建任务

POST https://{endpoint}/v3/jobs/build

{
  "job_id" : "f9d6c8466d614a9788e9a0acf6c15f46",
  "parameter" : [ {
    "name" : "codeBranch",
    "value" : "master"
  } ],
  "scm" : {
    "build_tag" : null,
    "build_commit_id" : "build_commit_id"
  }
}

响应示例

状态码: 200

OK

{
  "octopus_job_name" : "j_Oaqg...",
  "actual_build_number" : "20",
  "daily_build_number" : "20200612.20"
}

SDK代码示例

SDK代码示例如下。

执行任务ID为“f9d6c8466d614a9788e9a0acf6c15f46”,代码仓名称为“codeBranch”,代码仓分支为“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
52
53
54
55
56
57
58
59
60
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.codeartsbuild.v3.region.CodeArtsBuildRegion;
import com.huaweicloud.sdk.codeartsbuild.v3.*;
import com.huaweicloud.sdk.codeartsbuild.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class RunJobSolution {

    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);

        CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>"))
                .build();
        RunJobRequest request = new RunJobRequest();
        RunJobRequestBody body = new RunJobRequestBody();
        Scm scmbody = new Scm();
        scmbody.withBuildCommitId("build_commit_id");
        List<ParameterItem> listbodyParameter = new ArrayList<>();
        listbodyParameter.add(
            new ParameterItem()
                .withName("codeBranch")
                .withValue("master")
        );
        body.withScm(scmbody);
        body.withParameter(listbodyParameter);
        body.withJobId("f9d6c8466d614a9788e9a0acf6c15f46");
        request.withBody(body);
        try {
            RunJobResponse response = client.runJob(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());
        }
    }
}

执行任务ID为“f9d6c8466d614a9788e9a0acf6c15f46”,代码仓名称为“codeBranch”,代码仓分支为“master”的构建任务

执行任务ID为“f9d6c8466d614a9788e9a0acf6c15f46”,代码仓名称为“codeBranch”,代码仓分支为“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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/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 := codeartsbuild.NewCodeArtsBuildClient(
        codeartsbuild.CodeArtsBuildClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RunJobRequest{}
	buildCommitIdScm:= "build_commit_id"
	scmbody := &model.Scm{
		BuildCommitId: &buildCommitIdScm,
	}
	var listParameterbody = []model.ParameterItem{
        {
            Name: "codeBranch",
            Value: "master",
        },
    }
	request.Body = &model.RunJobRequestBody{
		Scm: scmbody,
		Parameter: &listParameterbody,
		JobId: "f9d6c8466d614a9788e9a0acf6c15f46",
	}
	response, err := client.RunJob(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码