# 配置流水线连接器
流水线连接器用于对接华为云流水线服务。
流水线（CodeArts Pipeline）提供可视化、可定制的持续交付流水线服务，实现缩短交付周期和提升交付质量的效果
#### 前提条件
使用流水线连接器前，需要开通流水线服务。
#### 创建流水线连接
1. 登录[ROMA Connect控制台](https://console.huaweicloud.com/roma3)。

2. 在左侧导航栏选择"连接器"，在连接器页面单击"新建连接"。
3. 选择"流水线"连接器。
4. 在弹窗中配置连接器信息，完成后单击"确定"。
   
   | 参数                | 说明                                                                                                                                                         |
   |:---|:---|
   | 连接名称              | 填写连接器实例名称。                                                                                                                                                 |
   | 描述                | 填写连接器的描述信息，用于识别不同的连接器。                                                                                                                                     |
   | Access Key        | 当前账号的AK（Access Key ID）。请参考[访问密钥](https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html)获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。    |
   | Secret Access Key | 当前账号的SK（Secret Access Key）。请参考[访问密钥](https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html)获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。 |
      
   
 
#### 支持的动作
- 获取项目下流水线执行状况
- 获取流水线状态
- 获取流水线列表接口
- 删除流水线
- 批量获取流水线状态
- 停止流水线
- 启动流水线
- 检查流水线创建状态
- 查询模板详情
- 查询模板列表
 
#### 配置参数
表1获取项目下流水线执行状况 
| 参数         | 说明                               |
|:---|:---|
| region_id  | 区域ID。                            |
| project_id | 项目ID。                            |
| start_date | 起始日期，起始日期和结束日期间隔不超过一个月，查询包含起始日期。 |
| end_date   | 结束日期，起始日期和结束日期间隔不超过一个月，查询包含结束日期。 |
| offset     | 偏移量，表示从此偏移量开始查询，offset大于等于0。     |
| limit      | 每次查询的条目数量。                       |
   
表2获取流水线状态 
| 参数          | 说明           |
|:---|:---|
| pipeline_id | 要获取状态的流水线ID。 |
| region_id   | 区域ID。        |
| build_id    | 要获取状态的执行ID。  |
   
表3获取流水线列表接口 
| 参数            | 说明                                                                                                  |
|:---|:---|
| region_id     | 区域ID。                                                                                               |
| pipeline_name | 流水线名字。参数存在，则进行模糊匹配。                                                                                 |
| project_ids   | devCloud项目ids。该参数存在，则获取对应项目下的流水线列表，逗号分隔，id个数取值\[0,10\]；如果不存在，则获取调用方所属租户的流水线列表。                      |
| creator_ids   | 创建人id。该参数存在，逗号分隔，id个数取值\[0,10\]。                                                                    |
| executor_ids  | 执行人id。该参数存在，逗号分隔，id个数取值\[0,10\]。                                                                    |
| status        | 流水线运行状态。取值范围：waiting,running,verifying,handling,suspending,completed。                               |
| outcome       | 流水线结果，标记流水线。error、success、aborted。                                                                  |
| sort_key      | 用于排序的字段。取值为：pipeline_name,create_time,start_time。                                                   |
| sort_dir      | 排序类型。asc按排序字段升序，desc按排序字段降序。                                                                        |
| git_url       | codehub搜索链接：git@codehub.XXX.git；gitee搜索链接：git@gitee.com.XXX.git；github搜索链接：git@github.com.XXX.git等。 |
| offset        | 偏移量。表示从此偏移量开始查询，offset大于等于0，默认取值为0。                                                                 |
| limit         | 每次查询的条目数量。取值\[10-50\]，默认取值为10。                                                                      |
   
表4删除流水线 
| 参数          | 说明         |
|:---|:---|
| pipeline_id | 要删除的流水线ID。 |
| region_id   | 区域ID。      |
   
表5批量获取流水线状态 
| 参数           | 说明                 |
|:---|:---|
| region_id    | 区域ID。              |
| pipeline_ids | 要获取状态的流水线ID，用逗号隔开。 |
   
表6停止流水线 
| 参数          | 说明       |
|:---|:---|
| pipeline_id | 流水线ID。   |
| region_id   | 区域ID。    |
| build_id    | 流水线执行ID。 |
   
表7启动流水线 
| 参数          | 说明               |
|:---|:---|
| pipeline_id | 流水线ID。           |
| region_id   | 区域ID。            |
| name        | 构建参数名。           |
| value       | 构建参数值，最大长度为8192。 |
   
表8检查流水线创建状态 
| 参数        | 说明    |
|:---|:---|
| task_id   | 实例ID。 |
| region_id | 区域ID。 |
   
表9查询模板详情 
| 参数            | 说明     |
|:---|:---|
| template_id   | 模板ID。  |
| region_id     | 区域ID。  |
| template_type | 模板类型。  |
| source        | 接口调用方。 |
   
表10查询模板列表 
| 参数            | 说明                           |
|:---|:---|
| region_id     | 区域ID。                        |
| template_type | 模板类型。                        |
| is_build_in   | 是否内置模板。                      |
| offset        | 偏移量，表示从此偏移量开始查询，offset大于等于0。 |
| limit         | 每页显示的条目数量。                   |
| name          | 模板名称，匹配规则为模糊匹配。              |
| sort          | 排序字段。                        |
| asc           | 是否正序。                        |