创建推送规则。
接口说明
需要代码库管理员以上权限。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /api/v4/projects/{repositoryId}/push_rule
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| organizationId | string | 是 | 企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】 | 5ebbc0228123212b59xxxxx |
| accessToken | string | 否 | 个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段 | f0b1e61db5961df5975a93f9129d2513 |
| repositoryId | long | 是 | 代码库 ID | 187687 |
| body | object | 否 | 请求 Body | |
| ruleInfos | array<object> | 是 | 规则列表 | |
| object | 否 | 某项规则 | ||
| checkerName | string | 否 | 规则名称，可选值：
| CommitMessageChecker |
| extraMessage | string | 否 | 在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效：
| user@example.com |
| checkerType | string | 否 | 该字段作用于代码属主检查下的限制级别设置，仅检查作者和检查提交者有效，其他规则可不传值，可选值：
| warn |
| fileRuleRegexes | array | 否 | 该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制 | |
| string | 否 | 文件限制正则表达式 | \.java$ |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
"errorCode": "\"\"",
"errorMessage": "\"\"",
"success": true,
"result": {
"id": 2077,
"ruleInfos": [
{
"checkerName": "ForcePushChecker",
"checkerType": "warn",
"extraMessage": "disabled",
"fileRuleRegexes": [
"\\.java$\n"
]
}
],
"gmtCreate": "2023-09-03T18:20:06+08:00",
"gmtModified": "2023-09-03T18:20:06+08:00"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史