# 查询指定构建记录详情 - ShowBuildRecord #### 功能介绍 查询指定构建记录详情。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codeci/cloudbuild_03_0007.html)。 #### 授权信息 当前API调用无需身份策略权限。 #### URI GET /v1/record/{record_id}/info 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | record_id | 是 | String | **参数解释**： 构建记录唯一标识。由ShowJobBuildRecordDetail(获取构建记录信息)接口返回。调用该接口即可获得构建记录ID。 **约束限制**： 不涉及。 **取值范围**： 36位数字、小写字母、'-'组合。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。（响应消息头中X-Subject-Token的值）。通过调用IAM服务接口获取，参考[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)。 **约束限制**： 不支持租户全局token，请使用scope为project的region级token。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | [BuildRecord] object | **参数解释**： 项目列表。 **取值范围**： 不涉及。 | | error | Object | **参数解释**： 返回错误信息。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 返回状态信息。 **取值范围**： ● success：表示接口调用成功。 ● fail：表示接口调用失败。 | 表4BuildRecord | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 唯一标识。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 接口响应状态。 **取值范围**： 不涉及。 | | status_code | Integer | **参数解释**： 状态码。 **取值范围**： 不涉及。 | | create_time | String | **参数解释**： 创建时间。 **取值范围**： 不涉及。 | | schedule_time | String | **参数解释**： 构建下发的时间。 **取值范围**： 不涉及。 | | queued_time | String | **参数解释**： 排队时间。 **取值范围**： 不涉及。 | | start_time | String | **参数解释**： 开始时间。 **取值范围**： 不涉及。 | | finish_time | String | **参数解释**： 完成时间。 **取值范围**： 不涉及。 | | duration | Integer | **参数解释**： 持续时间。 **取值范围**： 不涉及。 | | build_duration | Integer | **参数解释**： 构建时间。 **取值范围**： 不涉及。 | | pending_duration | Integer | **参数解释**： 等待时间。 **取值范围**： 不涉及。 | | project_id | String | **参数解释**： CodeArts项目ID。构建任务所在项目的ID。 **取值范围**： 不涉及。 | | display_name | String | **参数解释**： 子任务名称。 **取值范围**： 不涉及。 | | trigger_name | String | **参数解释**： 触发者名称。 **取值范围**： 不涉及。 | | group_name | String | **参数解释**： 仓库分组名称。 **取值范围**： 不涉及。 | | execution_id | String | **参数解释**： 八爪鱼任务ID。 **取值范围**： 不涉及。 | | parameters | Array of [parameters] objects | **参数解释**： 构建执行参数列表。 **取值范围**： 不涉及。 | | repository | String | **参数解释**： 仓库地址。 **取值范围**： 不涉及。 | | branch | String | **参数解释**： 分支名。 **取值范围**： 不涉及。 | | revision | String | **参数解释**： commitId。 **取值范围**： 不涉及。 | | build_yml_path | String | **参数解释**： yaml路径。 **取值范围**： 不涉及。 | | build_yml_url | String | **参数解释**： 代码化构建的yaml文件地址 **取值范围**： 不涉及。 | | daily_build_number | String | **参数解释**： 构建每日编号。 **取值范围**： 不涉及。 | | build_record_type | [build_record_type] object | **参数解释**： 构建记录类型。 **取值范围**： 不涉及。 | | trigger_type | String | **参数解释**： 触发方式，可选值：手工触发(MANUAL)，定时触发(TIMED_EXECUTION)，代码更新触发(CODEHUB_TRIGGER)，流水线触发(PIPELINE_TRIGGER)。 **取值范围**： ● MANUAL：手工触发。 ● TIMED_EXECUTION：定时触发。 ● CODEHUB_TRIGGER：代码更新触发。 ● PIPELINE_TRIGGER：流水线触发。 | | scm_type | String | **参数解释**： 代码源仓库类型。 **取值范围**： gitee_private\|codehub\|gitee\|github\|general_git\|externalGit\|gerrit\|tfs_git\|gitcode\|other_project_codehub\|bitbucket。 | | scm_web_url | String | **参数解释**： 代码源地址。 **取值范围**： 不涉及。 | | user_id | String | **参数解释**： 用户id。 **取值范围**： 不涉及。 | | build_no | String | **参数解释**： 构建编码。 **取值范围**： 不涉及。 | | daily_build_no | String | **参数解释**： 构建每日编号。 **取值范围**： 不涉及。 | 表5parameters | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 参数名。 **取值范围**： 不涉及。 | | secret | Boolean | **参数解释**： 是否为私密参数。 **取值范围**： ● true：是私密参数。 ● false：不是私密参数。 | | value | String | **参数解释**： 参数值。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 类型。 **取值范围**： ● string：表示参数类型为字符串。 ● Enumeration：表示参数类型为枚举值。 ● Auto Increment：表示参数类型为自增长。 | 表6build_record_type | 参数 | 参数类型 | 描述 | |:---|:---|:---| | trigger_type | String | **参数解释**： 触发方式，可选值：手工触发(MANUAL)，定时触发(TIMED_EXECUTION)，代码更新触发(CODEHUB_TRIGGER)，流水线触发(PIPELINE_TRIGGER)。 **取值范围**： ● MANUAL：手工触发。 ● TIMED_EXECUTION：定时触发。 ● CODEHUB_TRIGGER：代码更新触发。 ● PIPELINE_TRIGGER：流水线触发。 | | record_type | String | **参数解释**： 记录类型。 **取值范围**： ● JOB：表示记录类型为任务类型。 ● BUILDFLOW：表示记录类型为构建流类型。 | #### 请求示例 ``` GET https://{endpoint}/v1/record/41f0e24d-d435-4f80-88cd-19dba310f845/info ``` #### 响应示例 **状态码：200** OK ``` { "result" : { "id" : "41f0e24d-d435-4f80-88cd-19dba310f845", "status" : "SUCCESS", "duration" : 26183, "parameters" : [ { "name" : "codeBranch", "secret" : false, "type" : "string", "value" : "master" } ], "repository" : "https://codehub.devcloud.{region}.huawei.com:CodeCIEdgejkcsxm00001/APITest-maven.git", "branch" : "master", "revision" : "e980b883c1590363818225ec649d7cf161f0d49c", "status_code" : 5, "create_time" : "2024-06-29T08:56:18.000+00:00", "schedule_time" : "2024-06-29T08:56:19.000+00:00", "queued_time" : "2024-06-29T08:56:20.000+00:00", "start_time" : "2024-06-29T08:56:23.000+00:00", "finish_time" : "2024-06-29T08:56:46.000+00:00", "build_duration" : 23183, "pending_duration" : 3000, "project_id" : "260380a1-5773-44e5-9122-8e4b3aa63fe8", "display_name" : "APITest-maven", "trigger_name" : "testUser", "group_name" : "", "execution_id" : "j_RY0zZT3L", "build_yml_path" : ".cloudbuild/build.yml", "build_yml_url" : "https://codehub.devcloud.{region}.huawei.com:CodeCIEdgejkcsxm00001/APITest-maven/blob/e980b883c1590363818225ec649d7cf161f0d49c/.cloudbuild/build.yml", "daily_build_number" : "20240629.8", "build_record_type" : { "trigger_type" : "MANUAL", "record_type" : "JOB" }, "trigger_type" : "MANUAL", "scm_type" : "codehub", "scm_web_url" : "https://devcloud.{region}.huawei.com/codehub/2111859403/home", "user_id" : "ae22fd035f354cfa8d82a3f1c8940446", "build_no" : "6463", "daily_build_no" : "20240629.8" }, "error" : null, "status" : "success" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ShowBuildRecordSolution { 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("")) .build(); ShowBuildRecordRequest request = new ShowBuildRecordRequest(); request.withRecordId("{record_id}"); try { ShowBuildRecordResponse response = client.showBuildRecord(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ShowBuildRecordRequest() request.record_id = "{record_id}" response = client.show_build_record(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartsbuild.CodeArtsBuildClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartsbuild.NewCodeArtsBuildClient(hcClient) request := &model.ShowBuildRecordRequest{} request.RecordId = "{record_id}" response, err := client.ShowBuildRecord(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsBuild/sdk?api=ShowBuildRecord)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeci/ErrorCode.html)。