查看构建任务构建信息
功能介绍
查看构建任务构建信息。
调用方法
请参见如何调用API。
URI
GET /v1/job/{job_id}/info
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
job_id |
是 |
String |
参数解释: 填写需要查询构建历史列表的构建任务ID。获取方法:在构建任务详情页,拷贝浏览器URL末尾的32位数字、字母组合的字符串,即为构建任务ID。 约束限制: 不涉及。 取值范围: 只能是英文字母和数字,长度为32个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
参数解释: 任务信息。 取值范围: 不涉及。 |
error |
String |
参数解释: 返回错误信息。 取值范围: 不涉及。 |
status |
String |
参数解释: 返回状态信息。 取值范围: ● success:表示接口调用成功。 ● fail:表示接口调用失败。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 构建任务ID。 取值范围: 不涉及。 |
project_id |
String |
参数解释: 构建工程ID,唯一对应codeci_job_id。 取值范围: 不涉及。 |
project_permission_switch |
Boolean |
参数解释: 使用项目权限。 取值范围: 不涉及。 |
build_time |
String |
参数解释: 执行时间。 取值范围: 不涉及。 |
charge_time |
String |
参数解释: 收费时间。 取值范围: 不涉及。 |
create_time |
Long |
参数解释: 任务创建时间。 取值范围: 不涉及。 |
disabled |
Boolean |
参数解释: 是否已禁用。 取值范围: ● true:已禁用。 ● false:未禁用。 |
favorite |
Boolean |
参数解释: 是否已收藏。 取值范围: ● true:已收藏。 ● false:未收藏。 |
source_code |
String |
参数解释: 代码来源。 取值范围: 不涉及。 |
running_status |
String |
参数解释: 运行状态。 取值范围: 不涉及。 |
new_build |
Boolean |
参数解释: 重新运行。 取值范围: ● true:重新运行。 ● false:不重新运行。 |
job_name |
String |
参数解释: 任务名称。 取值范围: 不涉及。 |
is_copy |
Boolean |
参数解释: 是否有复制任务权限。 取值范围: ● true:有复制任务权限。 ● false:没有复制任务权限。 |
is_delete |
Boolean |
参数解释: 是否有删除任务权限。 取值范围: ● true:有删除任务权限。 ● false:没有删除任务权限。 |
is_execute |
Boolean |
参数解释: 是否有执行任务权限。 取值范围: ● true:有执行任务权限。 ● false:没有执行任务权限。 |
is_forbidden |
Boolean |
参数解释: 是否有禁用任务权限。 取值范围: ● true:有禁用任务权限。 ● false:没有禁用任务权限。 |
is_manager |
Boolean |
参数解释: 是否有管理任务权限。 取值范围: ● true:有管理任务权限。 ● false:没有管理任务权限。 |
is_modify |
Boolean |
参数解释: 是否有修改任务权限。 取值范围: ● true:有修改任务权限。 ● false:没有修改任务权限。 |
is_view |
Boolean |
参数解释: 是否有查看任务权限。 取值范围: ● true:有查看任务权限。 ● false:没有查看任务权限。 |
last_build_status |
String |
参数解释: 最终构建状态。 取值范围: 不涉及。 |
last_build_time |
Integer |
参数解释: 最后构建时间。 取值范围: 不涉及。 |
health_score |
Integer |
参数解释: 健康度。 取值范围: 不涉及。 |
状态码: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/info
响应示例
状态码:200
OK
{ "result" : { "id" : "f5af662119404ad187437cd272b5099b", "project_id" : "85caf40575794f989920-5216d1148af6", "project_permission_switch" : true, "build_time" : "27.51", "charge_time" : "15.17", "create_time" : "1717574458000", "disabled" : false, "favorite" : false, "source_code" : "test", "running_status" : "Finished", "new_build" : false, "job_name" : "jobname", "is_copy" : true, "is_delete" : true, "is_execute" : true, "is_forbidden" : true, "is_manager" : true, "is_modify" : true, "is_view" : true, "last_build_status" : "success", "last_build_time" : 1721793407000, "health_score" : 74 }, "status" : "success", "error" : null }
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 ShowJobInfoSolution { 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(); ShowJobInfoRequest request = new ShowJobInfoRequest(); request.withJobId("{job_id}"); try { ShowJobInfoResponse response = client.showJobInfo(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 = ShowJobInfoRequest() request.job_id = "{job_id}" response = client.show_job_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.ShowJobInfoRequest{} request.JobId = "{job_id}" response, err := client.ShowJobInfo(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 |
错误码
请参见错误码。