获取构建任务详情
功能介绍
获取构建任务详情。
调用方法
请参见如何调用API。
URI
GET /v1/job/{job_id}/config
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
job_id |
是 |
String |
参数解释: 填写需要查询构建历史列表的构建任务ID。获取方法:在构建任务详情页,拷贝浏览器URL末尾的32位数字、字母组合的字符串,即为构建任务ID。 约束限制: 不涉及。 取值范围: 只能是英文字母和数字,长度为32个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
get_all_params |
否 |
String |
参数解释: 输入"true"或者"false"来控制返回参数是不是完整的。 约束限制: 不涉及。 取值范围: true|false。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
CreateBuildJobResponseVo object |
参数解释: 查询模板结果。 取值范围: 不涉及。 |
error |
String |
参数解释: 返回错误信息。 取值范围: 不涉及。 |
status |
String |
参数解释: 返回状态信息。 取值范围: ● success:表示接口调用成功。 ● fail:表示接口调用失败。 |
参数 |
参数类型 |
描述 |
---|---|---|
arch |
String |
参数解释: 使用机器的架构。 取值范围: x86-64或者arm。 |
project_id |
String |
参数解释: CodeArts项目ID。构建任务所在项目的ID。 取值范围: UUID,32位数字、字母组合的字符串。 |
job_name |
String |
参数解释: 构建任务名称。 取值范围: • 支持中英文,数字,下划线“_”和连接符“-”。 • 字符长度范围为1~115。 |
auto_update_sub_module |
String |
参数解释: 是否自动更新子模块。 取值范围: false:不更新子模块。 true:更新子模块。 |
flavor |
String |
参数解释: 执行机规格。 取值范围: 不涉及。 |
host_type |
String |
参数解释: 主机类型。 取值范围: 不涉及。 |
build_config_type |
String |
参数解释: 构建配置类型,YAML或ACTION。 取值范围: YAML或ACTION。 |
build_if_code_updated |
Boolean |
参数解释: 提交代码触发构建开关。 取值范围: true:提交代码触发执行构建任务。 false:提交代码不触发执行构建任务。 |
parameters |
Array of CreateBuildJobParameterResponse objects |
参数解释: 构建任务的执行参数列表。 取值范围: 不涉及。 |
group_id |
String |
参数解释: 任务分组ID。 取值范围: 不涉及。 |
timeout |
CreateBuildTimeoutResponse object |
参数解释: 构建任务超时时间。 取值范围: 不涉及。 |
scms |
Array of CreateBuildJobScmResponse objects |
参数解释: 构建执行代码仓信息。 取值范围: 不涉及。 |
steps |
Array of CreateBuildJobStepsResponse objects |
参数解释: 构建执行的步骤。 取值范围: 不涉及。 |
triggers |
Array of TriggerResponse objects |
参数解释: 定时任务触发器集合。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 参数定义名,默认为hudson.model.StringParameterDefinition。 取值范围: 不涉及。 |
params |
Array of CreateBuildJobParameterParamResponse objects |
参数解释: 构建执行参数子参数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 参数字段名。 取值范围: 不涉及。 |
value |
String |
参数解释: 参数字段值。 取值范围: 不涉及。 |
limits |
Array of LimitsParamResponse objects |
参数解释: 枚举类参数限制。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
disable |
String |
参数解释: 是否生效,默认为"0",为生效状态。 取值范围: 不涉及。 |
display_name |
String |
参数解释: 参数展示的名字。 取值范围: 不涉及。 |
name |
String |
参数解释: 参数名字。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
limit |
String |
参数解释: 构建任务执行的超时时间。 取值范围: 0~4。 |
unit |
String |
参数解释: 超时时间单位。 取值范围: seconds,minute,hour。 |
参数 |
参数类型 |
描述 |
---|---|---|
branch |
String |
参数解释: 代码分支名称。 取值范围: 不涉及。 |
url |
String |
参数解释: 代码仓地址。 取值范围: 不涉及。 |
repo_id |
String |
参数解释: Repo代码仓的ID。 取值范围: 不涉及。 |
web_url |
String |
参数解释: 代码仓https地址。 取值范围: 不涉及。 |
scm_type |
String |
参数解释: 仓库类别。 取值范围: repo、github、gitee、gerrit、gitcode、codehub |
is_auto_build |
Boolean |
参数解释: 提交代码后是否触发构建。 取值范围: ● true:自动构建。 ● false:非自动构建。 |
enable_git_lfs |
Boolean |
参数解释: 是否启用gitlfs。 取值范围: ● true:启用gitlfs。 ● false:不启用gitlfs。 |
build_type |
String |
参数解释: 构建类型,分支构建、Tag构建、Commit构建。 取值范围: branch(分支构建),tag(Tag构建),commitId(Commit构建)。 |
depth |
String |
参数解释: 克隆深度。克隆深度是指距离最近一次提交的提交次数,该值越大,检出代码的深度越深。 取值范围: 1~25。 |
end_point_id |
String |
参数解释: 通用Git等代码拉取的服务扩展点ID。 取值范围: 不涉及。 |
source |
String |
参数解释: 代码仓库来源。 取值范围: 不涉及。 |
group_name |
String |
参数解释: 仓库分组名称。 取值范围: 不涉及。 |
repo_name |
String |
参数解释: 仓库名称。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
properties |
Map<String,Object> |
参数解释: 构建步骤配置参数。 取值范围: 不涉及。 |
module_id |
String |
参数解释: 构建步骤ID。 取值范围: 不涉及。 |
name |
String |
参数解释: 构建步骤名称。 取值范围: 不涉及。 |
version |
String |
参数解释: 构建步骤版本。 取值范围: 不涉及。 |
enable |
Boolean |
参数解释: 是否开启自动构建任务。 取值范围: ● true:开启。 ● false:不开启。 |
参数 |
参数类型 |
描述 |
---|---|---|
parameters |
Array of ParameterItemResponse objects |
参数解释: 自定义参数。 取值范围: 不涉及。 |
name |
String |
参数解释: 触发器类型。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 自定义参数名称。 取值范围: 自定义参数名称。支持字母,数字,下划线“_”,长度不超过128个字符。 |
value |
String |
参数解释: 参数值。 取值范围: 自定义参数的默认值。长度不超过8192个字符。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
POST https://{endpoint}/v1/job/48c66c6002964721be537cdc6ce0297b/config
响应示例
状态码:200
OK
{ "result" : { "steps" : null, "arch" : "x86-64", "project_id" : "a287e712be6c404ca26e5f69040fa12b", "job_name" : "oychap213i2", "auto_update_sub_module" : "false", "flavor" : "2u8g", "parameters" : [ { "name" : "hudson.model.StringParameterDefinition", "params" : [ { "name" : "name", "value" : "codeBranch", "limits" : null }, { "name" : "type", "value" : "normalparam", "limits" : null }, { "name" : "defaultValue", "value" : "master", "limits" : null }, { "name" : "description", "value" : "Code branch, predefined parameters", "limits" : null }, { "name" : "deletion", "value" : "false", "limits" : null }, { "name" : "defaults", "value" : "true", "limits" : null }, { "name" : "staticVar", "value" : "false", "limits" : null }, { "name" : "sensitiveVar", "value" : "false", "limits" : null } ] } ], "scms" : [ { "branch" : "master", "url" : "git@codehub.devcloud.{region}.huawei.com:soso-test00001/an.git", "is_auto_build" : false, "scm_type" : "codehub", "end_point_id" : null, "web_url" : "https://devcloud.{region}.huawei.com/codehub/2111746211/home", "source" : null, "build_type" : "branch", "depth" : "1", "repo_id" : "2111746211" } ], "host_type" : "devcloud" }, "error" : null, "status" : "success" }
SDK代码示例
SDK代码示例如下。
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 |
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.*; public class ShowJobConfigSolution { 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(); ShowJobConfigRequest request = new ShowJobConfigRequest(); request.withJobId("{job_id}"); try { ShowJobConfigResponse response = client.showJobConfig(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()); } } } |
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 |
# 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 = ShowJobConfigRequest() request.job_id = "{job_id}" response = client.show_job_config(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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.ShowJobConfigRequest{} request.JobId = "{job_id}" response, err := client.ShowJobConfig(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 |
错误码
请参见错误码。