根据开始时间和结束时间查看构建任务的构建历史列表
功能介绍
根据开始时间和结束时间查看构建任务的构建历史列表。
调用方法
请参见如何调用API。
URI
GET /v3/jobs/{job_id}/period-history
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
job_id |
是 |
String |
参数解释: 填写需要查询构建历史列表的构建任务ID。获取方法:在构建任务详情页,拷贝浏览器URL末尾的32位数字、字母组合的字符串,即为构建任务ID。 约束限制: 不涉及。 取值范围: 只能是英文字母和数字,长度为32个字符。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
是 |
Integer |
参数解释: 分页页码,表示从此页开始查询。 约束限制: 不涉及。 取值范围: 只能使用数字,大于等于0。 默认取值: 0 |
limit |
是 |
Integer |
参数解释: 每页显示的条目数量,limit小于等于100。 约束限制: 不涉及。 取值范围: 只能使用数字,小于等于100。 默认取值: 10 |
start_time |
是 |
String |
参数解释: 区间开始时间,格式yyyy-MM-dd。 约束限制: 开始时间和结束时间间隔不能超过30天。 取值范围: 满足此正则^[0-9]{4}-[0-9]{2}-[0-9]{2}$。 默认取值: 2021-01-04 |
end_time |
是 |
String |
参数解释: 区间开始时间,格式yyyy-MM-dd。 约束限制: 开始时间和结束时间间隔不能超过30天。 取值范围: 满足此正则^[0-9]{4}-[0-9]{2}-[0-9]{2}$。 默认取值: 2021-02-03 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
记录总数 |
history_records |
Array of history_records objects |
构建历史列表 |
参数 |
参数类型 |
描述 |
---|---|---|
record_id |
String |
构建记录id--唯一key |
job_id |
String |
任务id |
build_number |
Integer |
构建编号 |
start_time |
String |
构建开始时间 |
end_time |
String |
构建结束时间 |
result |
String |
构建结果 |
branch |
String |
代码分支 |
commit_id |
String |
代码提交的commit id |
commit_message |
String |
代码提交时用户输入的提交信息,只有使用codehub仓库时有值 |
executor |
String |
执行构建任务的用户的用户名 |
trigger_type |
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}/v3/jobs/{job_id}/period-history?start_time=2021-01-04&end_time=2021-01-14&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", "branch" : "master", "commit_id" : "2f37dd494927d2c6259417c58e5faeb72bfe7150", "commit_message" : "test", "executor" : "test", "trigger_type" : "手工触发" } }
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 ShowListPeriodHistorySolution { 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(); ShowListPeriodHistoryRequest request = new ShowListPeriodHistoryRequest(); request.withJobId("{job_id}"); try { ShowListPeriodHistoryResponse response = client.showListPeriodHistory(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 = ShowListPeriodHistoryRequest() request.job_id = "{job_id}" response = client.show_list_period_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) |
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.ShowListPeriodHistoryRequest{} request.JobId = "{job_id}" response, err := client.ShowListPeriodHistory(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 |
错误码
请参见错误码。