1. 授权认证
  2. 获取用户个人信息
  3. 项目协同
  4. 代码托管
  5. 持续集成
  6. 制品仓库
  7. 测试管理
  8. 文档管理
  1. 项目协同
  2. 代码仓库
  3. DevOps 实践之旅
  4. 一分钟开始持续集成之旅
  5. 持续部署
  6. 制品库

创建构建计划

接口描述

中文:创建构建计划

英文:CreateCodingCIJob

输入参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCodingCIJob。
ProjectId Integer 项目 ID
DepotId Integer 仓库 ID
Name String 构建计划名称
ExecuteIn String 执行方式 CVM | STATIC
TriggerMethodList.N Array of String REF_CHANGE 代码更新触发
CRON = 1 定时触发
MR_CHANGE MR 变动触发
HookType String 代码更新触发匹配规则 DEFAULT,TAG,BRANCH,CUSTOM
JenkinsFileFromType String STATIC,SCM 从代码库读取
AutoCancelSameRevision Boolean 自动取消相同版本
AutoCancelSameMergeRequest Boolean 自动取消相同 MR
TriggerRemind String 构建结果通知触发者机制
ALWAYS -总是通知;
BUILD_FAIL -仅构建失败时通知;
JobFromType String 构建计划来源 CODING
DepotType String 仓库类型 CODING,TGIT,GITHUB,GITLAB,GITLAB_PRIVATE,GITEE,NONE
BranchSelector String hookType 为 DEFAULT 时须指定
BranchRegex String hookType 为 CUSTOME 时须指定
JenkinsFilePath String JenkinsFileFromType 为 SCM 必填
JenkinsFileStaticContent String JenkinsFileFromType 为 STATIC 必填
CachePathList.N Array of CodingCIJobCachePath 任务缓存目录配置
EnvList.N Array of CIJobEnv 环境变量配置
ScheduleList.N Array of CodingCIJobSchedule 针对 CRON triggerMethod 的 schedule 规则配置, 暂只用于添加
AlwaysUserIdList.N Array of Integer 不管构建成功还是失败总是通知的用户
BuildFailUserIdList.N Array of Integer 仅构建失败时要通知的用户

输出参数

参数名称 类型 描述
Data CreateCodingCIJobData 创建构建计划返回结构
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

示例

输入示例

{
  "Action": "CreateCodingCIJob",
  "ProjectId": 1,
  "DepotId": 2,
  "Name": "job-name",
  "ExecuteIn": "CVM",
  "TriggerMethodList": ["MR_CHANGE","REF_CHANGE"],
  "HookType": "DEFAULT",
  "JenkinsFileFromType": "SCM",
  "TriggerRemind": "ALWAYS",
  "AutoCancelSameRevision": "false",
  "AutoCancelSameMergeRequest": "false",
  "JobFromType": "CODING",
  "DepotType": "CODING"
}

输出示例

{
  "Response": {
    "RequestId": "1",
    "Data": {
      "Id": 24
    }
  }
}

上一篇配置项目成员权限
最近更新
感谢反馈有用
感谢反馈没用