批量获取流水线状态
功能介绍
批量获取流水线状态和阶段信息
调用方法
请参见如何调用API。
URI
GET /v3/pipelines/status
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pipeline_ids |
是 |
String |
要获取状态的流水线ID,用逗号隔开 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of PipelineExecuteStates objects |
OK |
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
流水线执行结果。取值及含义:success:成功;error:失败;aborted:终止 |
status |
String |
流水线执行状态.取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成 |
stages |
Array of Stages objects |
阶段执行情况 |
executor |
String |
执行人 |
pipeline_name |
String |
流水线名字 |
pipeline_id |
String |
流水线ID |
build_id |
String |
流水线执行ID |
detail_url |
String |
流水线详情页URL |
modify_url |
String |
流水线编辑页URL |
start_time |
String |
开始执行时间 |
end_time |
String |
结束执行时间 |
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
阶段执行结果。取值及含义:success:成功;error:失败;aborted:终止 |
status |
String |
阶段执行状态。取值和含义:waiting:等待;running:执行中;verifying:待审核;suspending:挂起;completed:完成 |
name |
String |
阶段名字 |
parameters |
Object |
阶段运行参数 |
order |
Integer |
阶段顺序 |
dsl_method |
String |
阶段类型 |
display_name |
String |
阶段显示名称 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息 |
error_code |
String |
错误码 |
请求示例
GET https://{endpoint}/v3/pipelines/status?pipeline_ids=8025ba36a87a4dd5af496708c2961817,413937e669914f95bed293617886c6c1
响应示例
状态码: 200
OK
[ { "result" : "error", "status" : "completed", "stages" : [ { "result" : "success", "status" : "completed", "name" : "initial", "parameters" : null, "order" : 1, "dsl_method" : "initial", "display_name" : "源代码" }, { "result" : "success", "status" : "completed", "name" : "state_3", "parameters" : null, "order" : 2, "dsl_method" : "build", "display_name" : "构建" } ], "executor" : "executor", "pipeline_name" : "PipelineSvc测试勿删_继续执行", "pipeline_id" : "92a65e2337174fabbdbccda97ab7ffad", "detail_url" : "https://example.com", "modify_url" : "https://example.com", "start_time" : "2022-09-09 00:00:00", "end_time" : "2022-09-09 00:00:24", "build_id" : "25" } ]
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.codeartspipeline.v2.region.CodeArtsPipelineRegion; import com.huaweicloud.sdk.codeartspipeline.v2.*; import com.huaweicloud.sdk.codeartspipeline.v2.model.*; public class BatchShowPipelinesStatusSolution { 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); CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>")) .build(); BatchShowPipelinesStatusRequest request = new BatchShowPipelinesStatusRequest(); request.withPipelineIds("<pipeline_ids>"); try { BatchShowPipelinesStatusResponse response = client.batchShowPipelinesStatus(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 huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartspipeline.v2 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 = CodeArtsPipelineClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchShowPipelinesStatusRequest() request.pipeline_ids = "<pipeline_ids>" response = client.batch_show_pipelines_status(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" codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/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 := codeartspipeline.NewCodeArtsPipelineClient( codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchShowPipelinesStatusRequest{} request.PipelineIds = "<pipeline_ids>" response, err := client.BatchShowPipelinesStatus(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 |
错误码
请参见错误码。