华为云用户手册

创建OpenAPI连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“自定义连接”页签。 单击一个OpenAPI连接器的“新建连接”。 在“新建连接”弹窗中配置信息。 表5 新建连接参数说明（Basic鉴权） 参数 说明 连接名称 输入连接名称。 url地址 输入连接地址。 用户名 输入用户名。 密码 输入密码。 描述 输入描述信息。 此处以OpenAPI连接器选择“Basic”鉴权类型为例，当OpenAPI连接器选择其它鉴权类型，那么在新建连接时，则配置对应的鉴权参数。 如果自定义连接器为无鉴权方式，则无需新增连接。 单击“确定”，完成创建OpenAPI连接。

创建OpenAPI连接器 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“自定义连接”页签。 单击“新建连接器”，弹出“新建OpenAPI连接器”弹窗。 选择导入文件。 表1 导入文件说明 参数 说明 选择一个OpenAPI标准的文件 选择OpenAPI标准版本，可选择2.0或3.0。 单击“下载模板”可下载对应版本的OpenAPI标准模板文件。 根据业务需求修改模板文件并上传文件。 鉴权类型 选择连接器创建连接时，所需的认证类型。认证类型从OpenAPI规范中的安全方式中提取。 此处以导入3.0版本模板文件为例，可选如下鉴权类型。 api_key：API KEY认证。当选择API KEY鉴权类型时，支持编辑鉴权参数。 x-bfs-iam-token： IAM 用户Token认证。 x-bfs-iam-aksk：IAM用户AK/SK认证。 Basic：Basic认证。 无认证：无认证。 动作 选择需要配置的动作，动作将从OpenAPI规范中的API中提取。生成连接器后，可以添加触发器。 配置基本信息。 表2 基本信息说明 参数 说明 图标 自定义连接器的图标。 单击“上传图标”，可从本地上传一个图标。不上传则默认使用根据连接器名称首字母生成的标准图标。 连接器名称 填写连接器的名称。 标签 填写连接器的标签。 类别 选择连接器的类别。 HTTP 数据库 华为云服务 SaaS应用 邮箱 其他 消息系统 描述 填写连接器的描述信息，用于识别不同的连接器。 单击“创建并配置详情”，进入连接器的动作配置页面。 单击，在“新建动作”弹窗中配置动作信息，并单击“确定”。 表3 新建动作说明 参数 说明 动作名 填写动作名称。 类型 选择动作类型。 GET POST PUT DELETE 路径 填写路径，例如“/history”。 描述 输入动作描述。 新增动作完成后，配置动作参数。 表4 动作参数说明 参数 说明 输入参数 配置输入参数，可配置“Query”、“Header”两种类型的输入参数。 参数名：输入参数名。 参数展示名：输入参数展示名。 类型：选择参数类型，可选择“string”、“integer”、“number”。 是否必填：配置此参数是否为必填参数。 描述：输入参数描述。 单击“操作”栏下的，可以新增参数。 请求体 配置请求体参数。当动作类型配置为“POST”、“PUT”、“DELETE”时，需要配置请求体参数。 参数名：输入参数名。 参数展示名：输入参数展示名。 类型：选择参数类型，可选择“object”、“string”、“integer”、“number”。 是否必填：配置此参数是否为必填参数。 描述：输入参数描述。 单击“操作”栏下的，可以新增参数。 说明： 第一个参数的参数名默认为“根节点”，参数类型默认为“object”，均不支持修改。 返回值 配置返回值参数。在“返回值”栏下单击后在下拉框可以新增不同的返回值。 参数名：输入参数名。 参数展示名：输入参数展示名。 类型：选择参数类型，可选择“object”、“array”、“string”、“integer”。 是否必填：配置此参数是否为必填参数。 描述：输入参数描述。 单击“操作”栏下的，可以新增参数。 说明： 第一个参数的参数名默认为“根节点”，参数类型默认为“object”，均不支持修改。 单击“保存”，完成OpenAPI连接器的创建。

创建企业微信连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“企业微信”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 连接标识 连接类型 如果需要使用机器人推送消息功能，选择机器人；其他功能选择应用 企业ID 每个企业都拥有唯一的corpid，详情见企业微信《企业内部开发服务端API文档》“基本概念介绍”章节 应用凭证密钥 每一个应用都有一个独立的访问密钥，每个企业都拥有唯一的corpid，详情见企业微信《企业内部开发服务端API文档》“基本概念介绍”章节 机器人Key 机器人webhook中的请求参数key的值 描述 连接描述信息

支持的动作 获取部门ID列表 创建部门 更新部门 删除部门 获取成员ID列表 创建成员 更新成员 删除成员 获取群聊会话 创建群聊会话 修改群聊会话 推送文本消息 推送markdown消息 推送文件消息 推送图片消息 推送图文消息 推送文本卡片消息 撤回应用消息 推送文本消息到群聊 推送markdown消息到群聊 推送文件消息到群聊 推送图片消息到群聊 推送图文消息到群聊 推送文本卡片消息到群聊 机器人推送文本消息 机器人推送markdown消息 机器人推送文件消息 机器人推送图片消息 机器人推送图文消息

配置参数 表1 创建项目 参数 说明 Project Name 项目名称 Project Key 项目唯一标识 Project模板类型 项目模板 项目描述 描述 表2 更新项目 参数 说明 update by Project Key 项目唯一标识 Project Name 项目名称 项目描述 描述 表3 查询项目详情 参数 说明 Project Key 项目唯一标识 表4 删除项目 参数 说明 delete by Project Key 项目唯一标识 表5 创建issue 参数 说明 Project类型 项目类型 Project Key 项目唯一标识 Issue类型 issue类型 优先级 issue优先级 概要 issue概要 提出者 请输入用户名称 分配给 请输入用户名称 描述 issue描述 表6 修改issue 参数 说明 Project类型 项目类型 Project Key 项目唯一标识 名称 请输入issue名称或ID Issue类型 issue类型 优先级 issue优先级 概要 issue概要 提出者 请输入用户名称 分配给 请输入用户名称 描述 issue描述 表7 修改issue状态 参数 说明 Issue名称 请输入issue名称或ID 转换目标状态 需要选择issue支持的状态 表8 查询issue列表 参数 说明 Jql jira查询请求表达式 偏移量 分页offset，默认为0 最大返回数 分页limit 表9 查询issue详情 参数 说明 Issue名称 请输入issue名称或ID 表10 查询issue可指派用户 参数 说明 Project Key 项目唯一标识，新建issue情况下必填 Issue名称 请输入issue名称或ID，Project Key未填时该字段必填 JIRA用户名称 用于精确查询 表11 添加评论 参数 说明 Issue名称 请输入issue名称或ID 可见性 指定可见人范围 描述 评论内容 表12 修改评论 参数 说明 Issue名称 请输入issue名称或ID 评论ID 评论的ID 描述 评论内容 可见性 指定可见人范围 表13 查询评论列表 参数 说明 Issue名称 请输入issue名称或ID 偏移量 分页offset，默认为0 最大返回数 分页limit

创建JIRA连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“Jira Software”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 描述 填写连接器的描述信息，用于识别不同的连接器。 连接类型 选择JIRA的连接类型。 Cloud：指在云端部署的JIRA实例，用户可以使用任何Web浏览器从任何地方访问它。 On-Premise：指本地安装的JIRA实例，需要在自己的服务器或本地PC上安装和配置JIRA。 连接地址 填写JIRA的连接地址。 当“连接类型”选择“Cloud”时，连接地址格式为https://your-domain.atlassian.net。 your-domain指组织或团队的 域名 ，需要有有效的Jira Cloud订阅才能访问该地址。如果不确定您的Jira Cloud连接地址，可以从Atlassian账户或管理员处获取。 当“连接类型”选择“On-Premise”时，填写JIRA所在服务器的IP地址或主机名，例如：http://192.168.0.1:8080或http://jira.example.com:8080。 认证类型 选择JIRA的认证类型，支持选择“Basic”和“API Token”。 用户名 仅当“认证类型”选择“Basic”时需要配置。 连接JIRA的用户名。 密码 仅当“认证类型”选择“Basic”时需要配置。 连接JIRA的用户密码。 邮箱 仅当“认证类型”选择“API Token”时需要配置。 JIRA的邮箱。 API Token 仅当“认证类型”选择“API Token”时需要配置。 用户需要在JIRA的个人设置中生成一个API Token，API Token是一种用于身份验证的令牌，它允许JIRA用户通过API访问其账户和相关数据。

配置参数 表1 新增Pull Request评论 参数 说明 仓库名 填写GitHub中代码仓库的名字。 仓库所有者 填写GitHub中代码仓库的Owner。 pullRequest编号 填写要新增评论的pullRequest编号。 内容 填写评论的具体内容。 表2 关闭Pull Request 参数 说明 仓库名 填写GitHub中代码仓库的名字。 仓库所有者 填写GitHub中代码仓库的Owner。 pullRequest编号 填写要关闭评论的pullRequest编号。 表3 创建Issue 参数 说明 仓库名 填写GitHub中代码仓库的名字。 仓库所有者 填写GitHub中代码仓库的Owner。 标题 填写新建Issue的标题。 内容 填写新建Issue的具体内容。

创建CodeArts TestPlan连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts TestPlan”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 新建连接的名称，用于标识当前连接。 描述 新建连接的描述信息。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

配置参数 表1 实时计算单个自定义报表 参数 说明 project_id 项目ID plan_id 分支/计划ID region_id 区域ID name 报表名称 workpiece_type 工件类型（用例：case，测试套：suite） analysis_dim_row 分析维度 compare_dim_column 对比维度 creatorIds 创建人 ownerIds 所属人 ranks 级别 releaseIds releaseId status 状态 moduleIds 级别 results 结果 labelIds 标签 startTime 开始时间 endTime 结束时间 isAssociateIssue 是否关联需求 表2 查询某个测试计划下的需求树 参数 说明 project_id 项目ID plan_id 测试计划ID region_id 区域ID offset 起始偏移量 limit 每页显示条目数量，最大支持200条 表3 查询某测试计划下的操作历史 参数 说明 project_id 项目ID plan_id 测试计划ID region_id 区域ID offset 起始偏移量 limit 每页显示的条目数量，最大支持200条 表4 获取环境参数分组列表 参数 说明 project_id 项目ID region_id 区域ID offset 起始偏移量 limit 每页显示的条目数量，最大支持200条 表5 通过导入仓库中的文件生成接口测试套 参数 说明 project_id 项目ID region_id 区域ID testsuite_name 要生成的测试套名称 repository_id 仓库ID repository_branch 仓库分支 file_path 仓库中yaml或json文件的相对路径，仅支持swagger 2.0版本的yaml和json文件 表6 计划中批量添加测试用例 参数 说明 project_id 项目ID plan_id 计划ID region_id 区域ID service_id 注册测试类型服务接口返回的服务ID testcase_id_list 计划下包含的用例个数，数组长度小于50个，只能包含一种测试类型 表7 项目下查询测试计划列表v2 参数 说明 project_id 项目ID region_id 区域ID offset 起始偏移量 limit 每页显示的条目数量，最大支持200条 name 针对测试计划名称模糊查询 current_stage 在测试计划处截断（create，design，execute，report） 表8 项目下创建计划 参数 说明 project_id 项目ID region_id 区域ID name 计划名称 assigned_id 处理者ID service_id_list 计划下包含的用例类型，数组长度小于10 start_date 计划开始时间，要求用UTC时间表示，如2020-03-04 end_date 计划结束时间，要求用UTC时间表示，如2020-03-04 表9 项目下查询测试计划列表 参数 说明 project_id 项目ID region_id 区域ID name 针对测试计划名称模糊查询使用 current_stage 在测试计划处截断（create，design，execute，report） offset 页号，取值范围1-20000 limit 每页显示条目数量，取值范围1-200 表10 通过用例编号获取测试用例详情 参数 说明 project_id 项目ID region_id 区域ID testcase_number 用例编号 表11 批量更新测试用例结果 参数 说明 project_id 项目ID region_id 区域ID service_id 注册测试类型服务接口返回的服务ID testcase_id 测试用例ID execute_id 注册服务执行ID result_id 测试用例结果，（0-成功，1-失败，5-执行中，6-停止） end_time 用例结束执行的时间戳，在执行结束时该字段必填 duration 执行用例持续时长ms，更新状态时该字段必传 description 用于记录该次结果执行的备注信息 表12 批量执行测试用例 参数 说明 project_id 项目ID region_id 区域ID service_id 注册测试类型服务接口返回的服务ID plan_id 测试计划ID testcase_id 测试用例ID execute_id 注册服务执行ID result_id 测试用例结果（0-成功，1-失败，5-执行中，6-停止） start_time 用例开始执行的时间戳，在执行开始时该字段必填 表13 更新自定义测试服务类型用例 参数 说明 project_id 项目ID testcase_id 测试用例ID region_id 区域ID name 页面上显示的用例名称 service_id 注册测试类型服务接口返回的服务ID rank_id 测试用例等级，可选值为[0，1，2，3，4]，不填默认为2 testcase_number 用例编号，不填时自动生成 description 测试用例描述信息 preparation 执行该测试用例时需要满足的前置条件 expect_result 测试用例预期结果信息 test_step 测试步骤描述信息 label_list 标签名称列表 module_id 模块号 test_version_id 测试版本号 fix_version_id 迭代号 assigned_id 处理者ID信息 issue_id 用例关联的需求ID信息 status_id 测试用例状态信息（0-新建，5-设计中，6-测试中，7-完成） defect_id_list 缺陷ID信息 表14 获取测试用例详情 参数 说明 project_id 项目ID testcase_id 测试用例ID region_id 区域ID 表15 批量删除自定义测试服务类型用例 参数 说明 project_id 项目ID region_id 区域ID service_id 注册测试类型服务接口返回的服务ID test_case_id_list 测试用例ID 表16 创建自定义测试服务类型用例 参数 说明 project_id 项目ID region_id 区域ID name 页面上显示的用例名称 service_id 该值由注册接口返回 rank_id 测试用例等级，可选值为[0，1，2，3，4]，不填默认为2 testcase_number 用例编号，不填时自动生成 description 测试用例描述信息 preparation 执行该测试用例时需要满足的前置条件 expect_result 测试用例预期结果信息 test_step 测试步骤描述信息 label_list 标签名称列表 module_id 模块号 test_version_id 测试版本号 fix_version_id 迭代号 assigned_id 处理者ID信息 issue_id 用例关联的需求ID信息 表17 删除已注册服务 参数 说明 service_id 注册服务ID，该值由注册接口返回 region_id 区域ID 表18 更新已注册服务 参数 说明 service_id 注册服务ID，该值由注册接口返回 region_id 区域ID service_name 测试类型名称，用于界面显示，不能使用当前保留名 server_host 域名，服务会通过此域名进行接口调用，以https/http开头，长度小于等于128位字符。TestHub将会通过此域名下的接口，保证服务数据与客户系统数据的一致性 表19 新测试类型服务注册 参数 说明 region_id 区域ID service_name 测试类型名称，用于界面显示，不能使用当前保留名 server_host 域名，服务会通过此域名进行接口调用，以https/http开头，长度小于等于128位字符。TestHub将会通过此域名下的接口，保证服务数据与客户系统数据的一致性 表20 用户获取自己当前已经注册的服务 参数 说明 region_id 区域ID

支持的动作 实时计算单个自定义报表 查询某个测试计划下的需求树 查询某测试计划下的操作历史 获取环境参数分组列表 通过导入仓库中的文件生成接口测试套 计划中批量添加测试用例 项目下查询测试计划列表v2 项目下创建计划 项目下查询测试计划列表 通过用例编号获取测试用例详情 批量更新测试用例结果 批量执行测试用例 更新自定义测试服务类型用例 获取测试用例详情 批量删除自定义测试服务类型用例 创建自定义测试服务类型用例 删除已注册服务 更新已注册服务 新测试类型服务注册 用户获取自己当前已经注册的服务

创建CodeArts Req连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Req”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

支持的动作 查询迭代下工作项状态的统计数据（处理人维度） 查询项目的状态列表 更新项目的领域 查询项目的领域列表 删除项目的模块 取消领域与项目的关联关系 查询项目的模块列表 创建项目的领域 查看迭代历史记录 查询关联用例 查询当前工作项已经关联的代码提交记录 / 分支创建记录 查询当前工作项已经关联的关联Wiki 查询当前工作项已经关联的工作项 查询Scrum项目的工作项流转配置 获取项目概览 获取需求统计信息 查询项目下所有工作项的历史记录 获取bug统计信息 更新工作项 按用户查询工时（多项目） 批量删除工作项 删除工作项 获取工作项历史记录 创建工作项 查询项目的工作项 高级查询工作项 查询工作项详情 获取子工作项 按用户查询工时（单项目） 获取当前用户信息 查看迭代详情 获取指定项目的迭代列表 创建项目 更新Scrum项目迭代 删除项目迭代 批量删除项目的迭代 创建Scrum项目迭代 检查项目名称是否存在 获取指定工作项的评论列表 获取工作项完成率 获取指定项目的成员用户列表 添加项目成员 查询项目列表 查询缺陷密度 查询Scrum工作项自定义字段 细粒度权限用户创建工作项 查询人均bug 创建项目的模块 更新项目的模块 更新成员在项目中的角色 批量添加项目成员 批量删除项目成员 查询需求按时完成率 获取项目详情 更新项目 删除项目

支持的操作 获取分支目录下的文件 获取仓库统计数据 修改被流水线引用的仓库状态 判断用户是否有仓库的管理员权限 设置仓库是公开状态还是私有状态 获取一个项目下可以设置为公开状态的仓库列表 获取公开示例模板列表 获取项目下所有仓库信息 校验指定项目下的仓库名 创建仓库 根据仓库名组名获取仓库短ID，用以拼接与commitid对应提交详情页面url 根据组名和仓库名查询某仓库某分支对应的提交 查询指定仓库的webhook 为指定仓库添加hook 删除指定仓库的hook 查询某仓库对应的分支 根据仓库ID查询仓库某分支对应的提交，提供更多可选参数 添加部署密钥 删除仓库部署密钥 获取仓库上一次的提交统计信息 仓库统计 查询项目下的某个仓库 删除仓库 获取仓库所有成员记录 添加仓库成员 设置成员在仓库中的角色 删除仓库成员 查看仓库的创建状态 https账号密码校验 获取ssh key列表 添加ssh key 检验私钥是否有拉取代码的权限 删除用户公钥 查询用户的所有仓库 创建项目、仓库 创建项目并fork仓库； 查询项目下的所有仓库 查询某仓库的标签列表 新建标签 查询某个仓库的详细信息 查询某个仓库的提交信息 创建提交 查询某个仓库的特定提交信息 查询某个仓库的提交差异信息 查询某个仓库的文件信息 获取代码提交行数 下载仓库 新建保护分支 获取仓库分支列表 分支关联工作项 获取仓库合并请求列表 获取仓库合并请求详情

创建图像识别连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“华为云服务”类别下的“CodeArts Repo”。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 新建连接的名称，用于标识当前连接。 描述 新建连接的描述信息。 App Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 App Secret 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

配置参数 表1 获取项目下流水线执行状况 参数 说明 region_id Region ID project_id 项目ID start_date 起始日期，起始日期和结束日期间隔不超过一个月，查询包含起始日期 end_date 结束日期，起始日期和结束日期间隔不超过一个月，查询包含结束日期 offset 偏移量，表示从此偏移量开始查询，offset大于等于0 limit 每次查询的条目数量 表2 获取流水线状态 参数 说明 pipeline_id 要获取状态的流水线ID region_id Region ID build_id 要获取状态的执行ID 表3 获取流水线列表接口 参数 说明 region_id Region 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 Region ID 表5 批量获取流水线状态 参数 说明 region_id Region ID pipeline_ids 要获取状态的流水线ID，用逗号隔开 表6 停止流水线 参数 说明 pipeline_id 流水线ID region_id Region ID build_id 流水线执行ID 表7 启动流水线 参数 说明 pipeline_id 流水线ID region_id Region ID name 构建参数名 value 构建参数值，最大长度为8192 表8 检查流水线创建状态 参数 说明 task_id 实例ID region_id Region ID 表9 查询模板详情 参数 说明 template_id 模板ID region_id Region ID template_type 模板类型 source 接口调用方 表10 查询模板列表 参数 说明 region_id Region ID template_type 模板类型 is_build_in 是否内置模板 offset 偏移量，表示从此偏移量开始查询，offset大于等于0 limit 每页显示的条目数量 name 模板名称，匹配规则为模糊匹配 sort 排序字段 asc 是否正序

创建CodeArts Pipeline连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Pipeline”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 新建连接的名称，用于标识当前连接。 描述 新建连接的描述信息。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

创建CodeArts Deploy连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Deploy”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

支持的动作 修改任务规则集 任务配置高级选项 查询任务检查失败日志 任务配置屏蔽目录 查询任务的高级选项 新建检查任务 查询任务规则集的检查参数 任务配置检查参数 设置每个项目对应语言的默认规则集配置 创建自定义规则集 查询规则集列表 查看规则集的规则列表 查询任务的已选规则集列表 删除自定义规则集 查询任务的已选规则集列表 获取规则列表接口 查询任务规则集的检查参数 终止检查任务 查询缺陷详情的统计 修改缺陷状态 查询任务执行状态 历史扫描结果查询 查询缺陷概要 查询cmertrics缺陷概要 查询缺陷详情 查询任务列表 执行检查任务 删除检查任务

创建CodeArts Check连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Check”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

配置参数 表1 查询指定代码仓库最近一次成功的构建历史 参数 说明 project_id 项目ID。 region_id 区域ID。 repository_name 代码仓库名，不支持中文。 表2 获取构建历史详情信息接口 参数 说明 job_id 构建的任务ID。编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 build_number 构建任务的构建编号，从1开始，每次构建递增1。 region_id 区域ID。 表3 执行构建任务 参数 说明 region_id 区域ID。 body 输入请求体内容。 表4 根据开始时间和结束时间查看构建任务的构建成功率 参数 说明 job_id 构建的任务ID。编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 region_id 区域ID。 start_time 区间开始时间，格式yyyy-MM-dd。 end_time 区间结束时间，格式yyyy-MM-dd。 表5 查看任务运行状态 参数 说明 job_id 构建的任务ID。编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 region_id 区域ID。 表6 查看项目下用户的构建任务列表 参数 说明 project_id 项目ID。 region_id 区域ID。 page_index 分页页码， 表示从此页开始查询， page_index大于等于0。 page_size 每页显示的条目数量，page_size小于等于100。 表7 KeyStore文件下载 参数 说明 region_id 区域ID。 file_name 下载的文件名称。 domain_id 租户ID。32位数字、小写字母组合。 表8 根据开始时间和结束时间查看构建任务的构建历史列表 参数 说明 job_id 构建的任务ID。编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 region_id 区域ID。 offset 分页页码， 表示从此页开始查询， offset大于等于0。 limit 每页显示的条目数量，limit小于等于100。 start_time 区间开始时间，格式yyyy-MM-dd。开始时间和结束时间间隔不能超过30天。 end_time 区间结束时间，格式yyyy-MM-dd。开始时间和结束时间间隔不能超过30天。 表9 查看构建任务的构建历史列表 参数 说明 job_id 构建的任务ID。编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 region_id 区域ID。 offset 分页页码， 表示从此页开始查询， offset大于等于0。 limit 每页显示的条目数量，limit小于等于100。 interval 距今天的时间区间（单位：天），interval小于等于30。

创建CodeArts Build连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Build”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 填写连接器实例名称。 描述 填写连接器的描述信息，用于识别不同的连接器。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

创建CodeArts Artifact连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“CodeArts Artifact”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 连接名称 新建连接的名称，用于标识当前连接。 描述 新建连接的描述信息。 Access Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

创建 消息通知 服务连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“消息通知服务”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 描述 填写连接器的描述信息，用于识别不同的连接器。 鉴权方式 可选：“云服务委托”与“AK/SK”。 Access Key 当“鉴权方式”选择“AK/SK”时，需要配置 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 Secret Access Key 当“鉴权方式”选择“AK/SK”时，需要配置 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

配置参数 表1 发布模板消息 参数 说明 区域 选择服务所在的区域。 项目 选择服务所在的项目。 主题 在消息通知服务创建的主题，指消息发布或客户端订阅通知的特定事件类型。主题所有者可以为主题设置策略，例如，设置通信协议、限制消息发布和通知订阅的人员等。 消息标题 给邮箱订阅者发送邮件时作为消息主题。 模板 在消息通知服务创建的消息模板，指消息的固定格式，发布消息时可以使用已创建的消息模板向订阅者发送消息。 模板参数 配置模板中的参数。 表2 发布文本消息 参数 说明 区域 选择服务所在的区域。 项目 选择服务所在的项目。 主题 在消息通知服务创建的主题，指消息发布或客户端订阅通知的特定事件类型。主题所有者可以为主题设置策略，例如，设置通信协议、限制消息发布和通知订阅的人员等。 消息标题 给邮箱订阅者发送邮件时作为消息主题。 消息内容 给邮箱订阅者发送邮件时作为消息正文。

创建短信服务连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“短信服务”连接器。 在弹窗中配置连接器信息，完成后单击“确定”。 参数 说明 描述 填写连接器的描述信息，用于识别不同的连接器。 App Key 当前账号的AK（Access Key ID）。请参考访问密钥获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。 App Secret 当前账号的SK（Secret Access Key）。请参考访问密钥获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。

配置参数 表1 获取记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中的表名。 字段名 选择表名后，单击字段名框弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段。 WHERE条件 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写要查询数据的条件值（注意值要用英文单引号包住）。 Order by字段 填写返回结果的排序字段。 Limit条数 填写返回结果的每页数据条数。 Offset偏移量 填写分页查询的偏移量。 表2 添加记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中要插入数据的表名。 插入数据 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写插入操作中目标字段的值（注意值要用英文单引号包住）。 表3 更新记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中要更新数据的表名。 更新数据 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写更新操作中目标字段的值（注意值要用英文单引号包住）。 WHERE条件 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写要更新数据的条件值（注意值要用英文单引号包住）。 表4 删除记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中要删除数据的表名。 WHERE条件 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写要删除数据的条件值（注意值要用英文单引号包住）。

创建Oracle连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“Sql Server”连接器。 在弹窗中配置连接器信息，完成后单击“测试连接”，测试通过后，单击“确定”，保存配置。 参数 说明 连接名称 填写连接器实例名称。 连接与安全 选择数据库的连接模式。 默认：由系统根据用户配置自动拼接数据源连接字符串。 主机IP地址 填写数据库的连接IP地址。 端口 填写数据库的连接端口号。 数据库名 填写要连接的数据库名。 用户名 连接数据库的用户名。 密码 连接数据库的用户密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

创建Oracle连接 登录CodeArts Link控制台。 在左侧导航栏选择“连接器”，在连接器页面单击“新建连接”。 选择“PostgreSQL”连接器。 在弹窗中配置连接器信息，完成后单击“测试连接”，测试通过后，单击“确定”，保存配置。 参数 说明 连接名称 填写连接器实例名称。 连接与安全 选择数据库的连接模式。 默认：由系统根据用户配置自动拼接数据源连接字符串。 主机IP地址 填写数据库的连接IP地址。 端口 填写数据库的连接端口号。 数据库名 填写要连接的数据库名。 用户名 连接数据库的用户名。 密码 连接数据库的用户密码。 描述 填写连接器的描述信息，用于识别不同的连接器。

配置参数 表1 获取记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中的表名。 字段名 选择表名后，单击字段名框弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段。 WHERE条件 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写要查询数据的条件值（注意值要用英文单引号包住）。 Order by字段 填写返回结果的排序字段。 Limit条数 填写返回结果的每页数据条数。 Offset偏移量 填写分页查询的偏移量。 表2 添加记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中要插入数据的表名。 插入数据 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写插入操作中目标字段的值（注意值要用英文单引号包住）。 表3 更新记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中要更新数据的表名。 更新数据 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写更新操作中目标字段的值（注意值要用英文单引号包住）。 WHERE条件 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写要更新数据的条件值（注意值要用英文单引号包住）。 表4 删除记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中要删除数据的表名。 WHERE条件 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写要删除数据的条件值（注意值要用英文单引号包住）。

配置参数 表1 获取记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中的表名。 字段名 选择表名后，单击字段名框弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段。 WHERE条件 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写要查询数据的条件值（注意值要用英文单引号包住）。 Order by字段 填写返回结果的排序字段。 Limit条数 填写返回结果的每页数据条数。 Offset偏移量 填写分页查询的偏移量。 表2 添加记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中要插入数据的表名。 插入数据 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写插入操作中目标字段的值（注意值要用英文单引号包住）。 表3 更新记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中要更新数据的表名。 更新数据 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写更新操作中目标字段的值（注意值要用英文单引号包住）。 WHERE条件 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写要更新数据的条件值（注意值要用英文单引号包住）。 表4 删除记录 参数 说明 表名 单击后弹出下拉框和搜索框，可以根据搜索或下拉选择连接的数据库中要删除数据的表名。 WHERE条件 单击后弹出下拉框和搜索框，可以根据搜索或下拉勾选对应的字段，然后在对应的字段上填写要删除数据的条件值（注意值要用英文单引号包住）。