# 查看构建任务的构建历史列表 - ShowListHistory #### 功能介绍 查看构建任务的构建历史列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codeci/cloudbuild_03_0007.html)。 #### 授权信息 当前API调用无需身份策略权限。 #### URI GET /v3/jobs/{job_id}/history 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | job_id | 是 | String | **参数解释**： 填写需要查询构建历史列表的构建任务ID。获取方法：在构建历史列表页面，拷贝浏览器URL中"/detail/history/"之后的32位数字、字母组合的字符串，即为构建任务ID。 **约束限制**： 不涉及。 **取值范围**： 只能是英文字母和数字，长度为32个字符。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 是 | Integer | **参数解释**： 分页页码，表示从此页开始查询。 **约束限制**： 不涉及。 **取值范围**： 只能使用数字，大于等于0。 **默认取值：** 0 | | limit | 否 | Integer | **参数解释**： 每页显示的条目数量，limit大于0小于等于100。 **约束限制**： 不涉及。 **取值范围**： 只能使用数字，大于0小于等于100。 **默认取值：** 10 | | interval | 是 | Integer | **参数解释**： 距今天的时间区间（单位：天）。 **约束限制**： 不涉及。 **取值范围**： 只能使用数字，interval小于等于30。 **默认取值：** 7 | #### 请求参数 表3请求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** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | history_records | Array of [HistoryRecord] objects | **参数解释**： 构建历史列表。 **取值范围**： 不涉及。 | | total | Integer | **参数解释**： 记录总数。 **取值范围**： 0-2147483647 | 表5HistoryRecord | 参数 | 参数类型 | 描述 | |:---|:---|:---| | record_id | String | **参数解释**： 构建记录id--唯一key。 **取值范围**： 不涉及。 | | job_id | String | **参数解释**： 任务id。 **取值范围**： 不涉及。 | | build_number | Integer | **参数解释**： 构建编号。 **取值范围**： 0-2147483647 | | start_time | String | **参数解释**： 构建开始时间。 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 构建结束时间。 **取值范围**： 不涉及。 | | result | String | **参数解释**： 构建结果。 **取值范围**： 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v3/jobs/{job_id}/history?interval=7&offset=0&limit=10 ``` #### 响应示例 **状态码：200** OK ``` { "total" : 1, "history_records" : [ { "record_id" : "20201230.1", "job_id" : "f9d6c8466d614a9788e9a0acf6c15f46", "build_number" : 55, "start_time" : "2020-12-30T17:33:11+08:00", "end_time" : "2020-12-30T17:33:27+08:00", "result" : "FAILURE" } ] } ``` #### 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 ShowListHistorySolution { 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(); ShowListHistoryRequest request = new ShowListHistoryRequest(); request.withJobId("{job_id}"); try { ShowListHistoryResponse response = client.showListHistory(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 = ShowListHistoryRequest() request.job_id = "{job_id}" response = client.show_list_history(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.ShowListHistoryRequest{} request.JobId = "{job_id}" response, err := client.ShowListHistory(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=ShowListHistory)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeci/ErrorCode.html)。