Help Center/ ROMA Connect/ User Guide(new)/ Connectors/ Huawei Cloud Services/ CodeArts Pipeline

Updated on 2024-11-25 GMT+08:00

View PDF

CodeArts Pipeline

The CodeArts Pipeline connector interconnects with Huawei Cloud CodeArts Pipeline.

CodeArts Pipeline allows you to visualize and customize pipelines to shorten the delivery period and improve quality.

Prerequisites

You have subscribed to CodeArts Pipeline.

Creating a CodeArts Pipeline Connection

Log in to the new ROMA Connect console.
In the navigation pane on the left, choose Connector. On the page displayed, click New Connection.
Select the CodeArts Pipeline connector.
In the dialog box displayed, configure the connector and click OK.

Parameter	Description
Name	Enter the connector instance name.
Description	Enter the description of the connector to identify it.
Access Key	Access key ID (AK) of the current account. Obtain the AK by referring to Access Keys. If an AK/SK pair has been generated, find the downloaded AK/SK file (such as credentials.csv).
Secret Access Key	Secret access key (SK) of the current account. Obtain the SK by referring to Access Keys. If an AK/SK pair has been generated, find the downloaded AK/SK file (such as credentials.csv).

Action

Obtaining the pipeline execution status of a project
Obtaining the pipeline status
Obtaining the pipeline list
Deleting a pipeline
Obtaining pipeline status in batches
Stopping a pipeline
Starting a pipeline
Checking the pipeline creation status
Querying template details
Querying the template list

Configuring Parameters

**Table 1** Obtaining the pipeline execution status of a project
Parameter	Description
region_id	Region ID.
project_id	CodeArts project ID.
start_date	The start date is included in the query period. The interval between the start date and end date cannot exceed one month.
end_date	The end date is included in the query period. The interval between the start date and end date cannot exceed one month.
offset	Offset, which is the position where the query starts. The value must be no less than 0.
limit	Number of records of each query.

**Table 2** Obtaining the pipeline status
Parameter	Description
pipeline_id	ID of the pipeline whose status is to be queried.
region_id	Region ID.
build_id	Run ID of the pipeline whose status is to be queried.

**Table 3** Obtaining the pipeline list
Parameter	Description
region_id	Region ID.
pipeline_name	Pipeline name. If the parameter exists, fuzzy match is performed.
project_ids	CodeArts project IDs. If this parameter is specified, the pipeline list of the corresponding project is returned. Separated project IDs with commas (,). The number of IDs range from 0 to 10. If not, the pipeline list of the tenant to which the invoker belongs is returned.
creator_ids	Creator ID. Separated IDs with commas (,). The number of IDs range from 0 to 10.
executor_ids	Executor ID. Separated IDs with commas (,). The number of IDs range from 0 to 10.
status	Pipeline execution status. Value options: waiting, running, verifying, handling, suspending, and completed.
outcome	Pipeline result, which is used to mark the pipeline. Value options: error, success, aborted.
sort_key	Sorting field. Value options: pipeline_name, create_time, start_time.
sort_dir	Sorting type. asc: Ascending; desc: Descending.
git_url	Link format: git@codehub.XXX.git (CodeHub); git@gitee.com.XXX.git (Gitee); git@github.com.XXX.git (GitHub).
offset	Offset, which is the position where the query starts. Min.: 0 (default).
limit	Number of records of each query. Value range: 10 (default) to 50.

**Table 4** Deleting a pipeline
Parameter	Description
pipeline_id	ID of the pipeline to be deleted.
region_id	Region ID.

**Table 5** Obtaining pipeline status in batches
Parameter	Description
region_id	Region ID.
pipeline_ids	Pipeline IDs for status inquiry.

**Table 6** Stopping a pipeline
Parameter	Description
pipeline_id	Pipeline ID.
region_id	Region ID.
build_id	Pipeline execution ID.

**Table 7** Starting a pipeline
Parameter	Description
pipeline_id	Pipeline ID.
region_id	Region ID.
name	Name of the build parameter.
value	Value of the build parameter. Max. length: 8,192 characters.

**Table 8** Checking the pipeline creation status
Parameter	Description
task_id	Instance ID.
region_id	Region ID.

**Table 9** Querying template details
Parameter	Description
template_id	Template ID.
region_id	Region ID.
template_type	Template type.
source	API caller.

**Table 10** Querying the template list
Parameter	Description
region_id	Region ID.
template_type	Template type.
is_build_in	Built-in template or not.
offset	Offset, which is the position where the query starts. The value must be no less than 0.
limit	Number of items displayed per page.
name	Template name, which is fuzzily matched.
sort	Sorting field.
asc	Ascending order or not.

Parent topic: Huawei Cloud Services

Previous topic: CodeArts Req

Next topic: CodeArts Repo

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.