# 获取构建记录的有向无环图 - ShowBuildRecordFlowGraph #### 功能介绍 获取构建记录的有向无环图。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codeci/cloudbuild_03_0007.html)。 #### 授权信息 当前API调用无需身份策略权限。 #### URI GET /v1/record/{build_flow_record_id}/flow-graph 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | build_flow_record_id | 是 | String | **参数解释**： 父任务构建记录ID。 **约束限制**： 36位字符，8-4-4-4-12格式，支持UUID格式或Base32 Crockford编码格式。 **取值范围**： 小写字母a-f和数字0-9（UUID格式）或大写字母A-Z和数字0-9（Base32 Crockford编码格式），用连字符分隔。 **默认取值**： 不涉及。 | #### 请求参数 表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参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**： 接口响应状态。 **取值范围**： ● success：表示接口调用成功。 ● fail：表示接口调用失败。 | | error | Object | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | result | [result] object | **参数解释**： 调用接口成功后返回的数据。 **取值范围**： 不涉及。 | 表4result | 参数 | 参数类型 | 描述 | |:---|:---|:---| | edges | Array of [edges] objects | **参数解释**： edges。 **取值范围**： 不涉及。 | | vertices | Array of [Vertices] objects | **参数解释**： record信息。 **取值范围**： 不涉及。 | 表5edges | 参数 | 参数类型 | 描述 | |:---|:---|:---| | from | String | **参数解释**： 依赖子任务ID。 **取值范围**： 不涉及。 | | to | String | **参数解释**： 被依赖的子任务ID。 **取值范围**： 不涉及。 | 表6Vertices | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 子任务构建记录ID。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 子任务执行状态。 **取值范围**： ● PENDING：表示子任务执行状态为等待中。 ● STARTED：表示子任务执行状态为已开始。 ● SUCCESS：表示子任务执行状态为成功。 ● FAILURE：表示子任务执行状态为失败。 ● SCHEDULE_FAILURE：表示子任务执行状态为调度失败。 ● SCHEDULING：表示子任务执行状态为正在被调度。 ● SCHEDULED：表示子任务执行状态为已成功调度。 ● ABORTED：表示子任务执行状态为已中止。 ● UNKNOWN：表示子任务执行状态为未知。 | | display_name | String | **参数解释**： 子任务名称。 **取值范围**： 不涉及。 | | build_duration | Integer | **参数解释**： 子任务构建耗时。 **取值范围**： 不涉及。 | | start_time | String | **参数解释**： 子任务开始时间。 **取值范围**： 不涉及。 | | finish_time | String | **参数解释**： 子任务结束时间。 **取值范围**： 不涉及。 | | build_no | String | **参数解释**： 子任务构建编号。 **取值范围**： 0-2147483647 | #### 请求示例 ``` GET https://{endpoint}/v1/2ab0e6a3-3e1a-4708-bb16-fff2b0999027/flow-graph ``` #### 响应示例 **状态码：200** OK ``` { "error" : null, "status" : "success", "result" : { "edges" : [ { "from" : "d5587caf-05d7-42af-8ed2-daa20eb1de1b", "to" : "af81a8ff-1d53-4e0a-9108-fa7880366e73" } ], "vertices" : [ { "id" : "7607d919-6c21-43b3-a06e-ee016ff8e7c7", "status" : "SUCCESS", "display_name" : "job4", "build_duration" : 38156, "start_time" : "2020-12-30T17:33:11+08:00", "finish_time" : "2020-12-30T17:33:27+08:00", "build_no" : "535" } ] } } ``` #### 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 ShowBuildRecordFlowGraphSolution { 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(); ShowBuildRecordFlowGraphRequest request = new ShowBuildRecordFlowGraphRequest(); request.withBuildFlowRecordId("{build_flow_record_id}"); try { ShowBuildRecordFlowGraphResponse response = client.showBuildRecordFlowGraph(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 = ShowBuildRecordFlowGraphRequest() request.build_flow_record_id = "{build_flow_record_id}" response = client.show_build_record_flow_graph(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.ShowBuildRecordFlowGraphRequest{} request.BuildFlowRecordId = "{build_flow_record_id}" response, err := client.ShowBuildRecordFlowGraph(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=ShowBuildRecordFlowGraph)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeci/ErrorCode.html)。