流水线查看构建任务信息
功能介绍
流水线查看构建任务信息。
调用方法
请参见如何调用API。
URI
GET /v1/job/{job_id}/pipeline-info
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
job_id |
是 |
String |
参数解释: 填写需要查询构建历史列表的构建任务ID。获取方法:在构建任务详情页,拷贝浏览器URL末尾的32位数字、字母组合的字符串,即为构建任务ID。 约束限制: 不涉及。 取值范围: 只能是英文字母和数字,长度为32个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
all |
否 |
String |
参数解释: 输入"true"或者"false"来控制返回参数是不是完整的。 约束限制: 不涉及。 取值范围: true|false。 默认取值: true |
check_param_used |
否 |
String |
参数解释: 移除未使用的参数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
JobPipelineInfoItems object |
流水线查看构建任务信息结果 |
error |
String |
参数解释: 返回错误信息。 取值范围: 不涉及。 |
status |
String |
参数解释: 返回状态信息。 取值范围: ● success:表示接口调用成功。 ● fail:表示接口调用失败。 |
参数 |
参数类型 |
描述 |
---|---|---|
scms |
Array of CreateBuildJobScmResponse objects |
参数解释: 构建执行代码仓信息。 取值范围: 不涉及。 |
parameters |
parameters object |
参数解释: 参数。 取值范围: 不涉及。 |
job_name |
String |
参数解释: 任务名称。 取值范围: 不涉及。 |
job_name_massage |
String |
参数解释: 任务名称信息。 取值范围: 不涉及。 |
job_name_regex |
String |
参数解释: 任务名称正则。 取值范围: 不涉及。 |
source_code |
String |
参数解释: 任务名称正则。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数解释: 仓库名称。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
region |
String |
参数解释: 地域。 取值范围: 不涉及。 |
language |
String |
参数解释: 语言。 取值范围: 不涉及。 |
name |
String |
参数解释: 名称。 取值范围: 不涉及。 |
params |
Array of JobPipelineInfoParamsItems objects |
参数解释: 参数值。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 参数名称。 取值范围: 不涉及。 |
value |
String |
参数解释: 参数值。 取值范围: 不涉及。 |
状态码: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 |
错误描述 |
请求示例
GET https://{endpoint}/v1/job/901878212b1a49be9c1a1054c272762a/pipeline-info
响应示例
状态码:200
OK
{ "result" : { "scms" : [ { "url" : "git@codehub.devcloud.{region}.huawei.com:b4d3971c3988463b865f6f920846149e/aaa/Unit.git", "branch" : "master", "depth" : "1", "is_auto_build" : false, "repo_id" : "2111898074", "scm_type" : "codehub", "build_type" : "branch", "group_name" : "b4d3971c3988463b865f6f920846149e/aaa", "repo_name" : "Unit", "web_url" : "https://devcloud.{region}.huawei.com/codehub/2111898074/home" } ], "parameters" : { "name" : "hudson.model.StringParameterDefinition", "params" : [ { "name" : "name", "value" : "codeBranch" } ] }, "job_name" : "testJobName", "job_name_massage" : "Enter a maximum of 115 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.", "job_name_regex" : "", "source_code" : "codeci" }, "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 ShowJobPipelineInfoSolution { 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(); ShowJobPipelineInfoRequest request = new ShowJobPipelineInfoRequest(); request.withJobId("{job_id}"); try { ShowJobPipelineInfoResponse response = client.showJobPipelineInfo(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 = ShowJobPipelineInfoRequest() request.job_id = "{job_id}" response = client.show_job_pipeline_info(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.ShowJobPipelineInfoRequest{} request.JobId = "{job_id}" response, err := client.ShowJobPipelineInfo(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 |
错误码
请参见错误码。