Creating a Pipeline Group

Function

This API is used to create pipeline group.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipeline-group/create

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for . Constraints: N/A Value range: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition: Pipeline group name. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
project_id	Yes	String	Definition: CodeArts project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
parent_id	No	String	Definition: Parent group ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Definition: Group ID. Value range: The value consists of 32 characters, including digits and letters.
domain_id	String	Definition: Tenant ID, that is, domain ID of a user. Range: The value consists of 32 characters, including digits and letters.
project_id	String	Definition: Project ID. Value range: The value consists of 32 characters, including digits and letters.
name	String	Definition: Group name. Value range: The value consists of 32 characters, including digits and letters.
parent_id	String	Definition: Parent group ID. Value range: The value consists of 32 characters, including digits and letters.
path_id	String	Parameter description: Group path ID. For example, id1.id2.id3 indicates that the parent group of group id3 is id2, and the parent group of group id2 is id1. Value range: N/A.
ordinal	Integer	Definition: Sequence number. Value range: ≥ 0
creator	String	Definition: Creator ID. Value range: The value consists of 32 characters, including digits and letters.
updater	String	Definition: Updater ID. Value range: The value consists of 32 characters, including digits and letters.
create_time	Long	Parameter description: Creation time. Value range: N/A.
update_time	Long	Parameter description: Update time. Value range: N/A.
children	Array of PipelineGroupVo objects	Definition: Pipeline group details. Value range: N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

Example Requests

Create group G1.

POST https://{endpoint}/v5/{project_id}/api/pipeline-group/create

{
  "name" : "G1",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "parent_id" : ""
}

Example Responses

Status code: 200

{
  "id" : "58d55f8a646443a984e7399632b3963e",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec",
  "name" : "G1",
  "parent_id" : "",
  "path_id" : "58d55f8a646443a984e7399632b3963e",
  "ordinal" : 1,
  "creator" : "847a5317086c41798469d0868535943a",
  "updater" : null,
  "create_time" : null,
  "update_time" : null,
  "children" : null
}