El contenido no se encuentra disponible en el idioma seleccionado. Estamos trabajando continuamente para agregar más idiomas. Gracias por su apoyo.
Running a Build Task
Function
This API is used to run a build task and allows custom parameters.
Calling Method
For details, see Calling APIs.
URI
POST /v3/jobs/build
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. For details, see Obtaining an IAM User Token. Constraints Global tenant tokens are not supported. Use a region-level token whose scope is project. Range N/A. Default Value N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
job_id |
Yes |
String |
Definition Build task ID. It includes digits and letters. To obtain this ID, open the page for editing the build task in your browser, and copy the 32-character string at the end of the URL. Constraints The 32-character string sits at the end of the URL and includes digits and letters. Range N/A. Default Value N/A. |
parameter |
No |
Array of ParameterItem objects |
Definition Custom parameter. Constraints N/A. Range N/A. Default Value N/A. |
scm |
No |
Scm object |
Definition Code information. Constraints N/A. Range N/A. Default Value N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Definition Custom parameter name. Constraints ● Do not use the following fields: LD_PRELOAD, LD_LIBRARY_PATH, PATH, BASH_ENV, GIT_SSH_COMMAND, and path. ● Symbols are not supported. Range Custom parameter name. The length cannot exceed 128 characters. Only letters, digits, and underscores (_) are supported. Default Value N/A. |
value |
Yes |
String |
Definition Parameter value. Constraints N/A. Range Default value of the custom parameter. Max. 8,192 characters. Default Value N/A. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
octopus_job_name |
String |
Definition Temporary task name. Range N/A. |
actual_build_number |
String |
Definition Number of actual builds. Range N/A. |
daily_build_number |
String |
Definition Daily build number. Range N/A. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
Run the build task whose task ID is f9d6c8466d614a9788e9a0acf6c15f46. The task uses the codeBranch code repository and the master branch.
POST https://{endpoint}/v3/jobs/build
{
"job_id" : "f9d6c8466d614a9788e9a0acf6c15f46",
"parameter" : [ {
"name" : "codeBranch",
"value" : "master"
} ],
"scm" : {
"build_tag" : null,
"build_commit_id" : "build_commit_id"
}
}
Example Responses
Status code: 200
OK
{
"octopus_job_name" : "j_Oaqg...",
"actual_build_number" : "20",
"daily_build_number" : "20200612.20"
}
SDK Sample Code
The SDK sample code is as follows.
Run the build task whose task ID is f9d6c8466d614a9788e9a0acf6c15f46. The task uses the codeBranch code repository and the master branch.
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());
}
}
}
|
Run the build task whose task ID is f9d6c8466d614a9788e9a0acf6c15f46. The task uses the codeBranch code repository and the master branch.
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsbuild.v3 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 = CodeArtsBuildClient.new_builder() \
.with_credentials(credentials) \
.with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = RunJobRequest()
scmbody = Scm(
build_commit_id="build_commit_id"
)
listParameterbody = [
ParameterItem(
name="codeBranch",
value="master"
)
]
request.body = RunJobRequestBody(
scm=scmbody,
parameter=listParameterbody,
job_id="f9d6c8466d614a9788e9a0acf6c15f46"
)
response = client.run_job(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
Run the build task whose task ID is f9d6c8466d614a9788e9a0acf6c15f46. The task uses the codeBranch code repository and the master branch.
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)
}
}
|
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Run the build task whose task ID is f9d6c8466d614a9788e9a0acf6c15f46. The task uses the codeBranch code repository and the master branch.
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());
}
}
}
|
Run the build task whose task ID is f9d6c8466d614a9788e9a0acf6c15f46. The task uses the codeBranch code repository and the master branch.
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsbuild.v3 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 = CodeArtsBuildClient.new_builder() \
.with_credentials(credentials) \
.with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = RunJobRequest()
scmbody = Scm(
build_commit_id="build_commit_id"
)
listParameterbody = [
ParameterItem(
name="codeBranch",
value="master"
)
]
request.body = RunJobRequestBody(
scm=scmbody,
parameter=listParameterbody,
job_id="f9d6c8466d614a9788e9a0acf6c15f46"
)
response = client.run_job(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
Run the build task whose task ID is f9d6c8466d614a9788e9a0acf6c15f46. The task uses the codeBranch code repository and the master branch.
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)
}
}
|
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 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
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