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
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
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 forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A |
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
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. Value 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: None. |
ordinal |
Integer |
Parameter description: No. Value range: No less than 1. |
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: None. |
update_time |
Long |
Parameter description: Update time. Value range: None. |
children |
Array of PipelineGroupVo objects |
Definition: Pipeline running details. Value range: N/A |
Status code: 400
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
OK
{ "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 }
SDK Sample Code
The SDK sample code is as follows.
Create group G1.
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 47 48 49 50 51 |
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 CreatePipelineGroupSolution { 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(); CreatePipelineGroupRequest request = new CreatePipelineGroupRequest(); request.withProjectId("{project_id}"); PipelineGroupCreateDTO body = new PipelineGroupCreateDTO(); body.withParentId(""); body.withProjectId("d80a8a6530324b7bac972cbb8a9f28ec"); body.withName("G1"); request.withBody(body); try { CreatePipelineGroupResponse response = client.createPipelineGroup(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()); } } } |
Create group G1.
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 |
# 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 = CreatePipelineGroupRequest() request.project_id = "{project_id}" request.body = PipelineGroupCreateDTO( parent_id="", project_id="d80a8a6530324b7bac972cbb8a9f28ec", name="G1" ) response = client.create_pipeline_group(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create group G1.
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 |
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.CreatePipelineGroupRequest{} request.ProjectId = "{project_id}" parentIdPipelineGroupCreateDto:= "" request.Body = &model.PipelineGroupCreateDto{ ParentId: &parentIdPipelineGroupCreateDto, ProjectId: "d80a8a6530324b7bac972cbb8a9f28ec", Name: "G1", } response, err := client.CreatePipelineGroup(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot