创建构建计划
接口描述
中文:创建构建计划
英文: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
}
}
}

感谢反馈有用
感谢反馈没用