Obtaining the Directed Acyclic Graph of a Build Record (Unavailable Soon)

Function

This API is used to obtain the directed acyclic graph of a build record.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{build_flow_record_id}/flow-graph

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
build_flow_record_id	Yes	String	Definition Build record ID of a parent task. Constraints Use a 36-character string that includes digits and lowercase letters. Range N/A. Default Value N/A.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. (The value of the X-Subject-Token response header is the user token.) It can be obtained by calling the IAM service API. For details, seeObtaining an IAM User Token. Constraints Global tenant tokens are not supported. Use a region-level token whose scope is project. Range N/A. Default Value N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
success	Boolean	Definition Status. Range ● true: Success. ● false: Failure.
message	String	Definition Message. Range N/A.
err_code	String	Definition Error code. Range N/A.
result	result object	Definition Data returned after the API is successfully called. Range N/A.

**Table 4** result
Parameter	Type	Description
edges	Array of edges objects	Definition Edges. Range N/A.
vertices	Array of Vertices objects	Definition Record information. Range N/A.

**Table 5** edges
Parameter	Type	Description
from	String	Definition Dependent subtask ID. Range N/A.
to	String	Definition Dependency subtask ID. Range N/A.

**Table 6** Vertices
Parameter	Type	Description
id	String	Definition Build record ID of a subtask. Range N/A.
status	String	Definition Execution status of a subtask. Range N/A.
display_name	String	Definition Subtask name. Range N/A.
build_duration	Integer	Definition Build duration of a subtask. Range N/A.
start_time	String	Definition Subtask start time. Range N/A.
finish_time	String	Definition Subtask end time. Range N/A.
build_no	String	Definition Build number of a subtask. Range 0–2147483647

Example Requests

GET https://{endpoint}/v3/2ab0e6a3-3e1a-4708-bb16-fff2b0999027/flow-graph

Example Responses

Status code: 200

{
  "success" : true,
  "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"
    } ]
  }
}