CreatePushRule - 创建推送规则_云效(Apsara Devops)-阿里云帮助中心

通过OpenAPI创建推送规则。

适用版本

标准版

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
获取organizationId，请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限

产品	资源	所需权限
代码管理	推送规则	读写

请求语法

POST https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/pushRules

请求头

参数	类型	是否必填	描述	示例值

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是	组织 ID。	5ebbc0228123212b59xxxxx
repositoryId	string	path	是	代码库 ID 或者 URL-Encoder 编码的全路径。	187687
-	object	body	否
ruleInfos	array	body	否	规则信息列表。
-	object	body	否
checkerName	string	body	否	规则名称，可为：CommitMessageChecker - 提交说明规则；CommitAuthorEmailChecker - 提交邮箱规则；CommitAuthorChecker - 提交作者检查；CommitCommitterChecker - 提交人检查；ForcePushChecker - 强制推送检查；CommitFilesChecker - 提交文件限制规则；ThirdPartyChecker - 三方校验规则。	CommitMessageChecker
checkerType	string	body	否	限制级别设置：warn - 仅警告，允许推送，block - 禁止推送。	warn
extraMessage	string	body	否	在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效：1.提交说明规则，extraMessage 传入检查的正则表达式; 2.提交邮箱规则，extraMessage 传入检查的邮箱正则表示; 3.禁止强制推送，extraMessage 传入 "disabled"; 4.检查作者规则，extraMessage 传入 "on"，若不需要则不传值; 5.检查提交人规则，extraMessage 传入 "on"，若不需要则不传值; 6. 三方校验规则，比如传入空字符串。	on
fileRuleRegexes	array[string]	body	否	该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制。	\.java$
thirdPartyTimeout	integer	body	否	仅作用于三方校验规则，默认的超时时间为1000ms，三方校验服务的耗时尽可能不要超过1秒，也不建议将超时调大。	0
thirdPartyUrl	string	body	否	仅作用于三方校验规则，表示三方校验地址；如果 codeup 后端服务到第三方服务网络不通，则会调用失败，这是常见问题。	""

请求示例

curl -X 'POST' \
  'https://test.rdc.aliyuncs.com/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/pushRules' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "ruleInfos": [
            {
                "checkerName": "CommitMessageChecker",
                "checkerType": "warn",
                "extraMessage": "on",
                "fileRuleRegexes": [
                    "\.java$"
                ],
                "thirdPartyTimeout": 0,
                "thirdPartyUrl": ""
            }
        ]
    }'

返回参数

参数	类型	描述	示例值

参数	类型	描述	示例值
-	object
createdAt	string	创建时间。	2023-01-03T15:41:26+08:00
id	integer	推送规则主键 ID。	2077
ruleInfos	array	规则信息列表。
-	object
checkerName	string	规则名称，可为： - 提交说明规则；CommitAuthorEmailChecker - 提交邮箱规则；CommitAuthorChecker - 提交作者检查；CommitCommitterChecker - 提交人检查；ForcePushChecker - 强制推送检查；CommitFilesChecker - 提交文件限制规则；ThirdPartyChecker - 三方校验规则。	ForcePushChecker
checkerType	string	限制级别设置：warn - 仅警告，允许推送，block - 禁止推送。	warn
extraMessage	string	在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效：1.提交说明规则，extraMessage 传入检查的正则表达式; 2.提交邮箱规则，extraMessage 传入检查的邮箱正则表示; 3.禁止强制推送，extraMessage 传入 "disabled"; 4.检查作者规则，extraMessage 传入 "on"，若不需要则不传值; 5.检查提交人规则，extraMessage 传入 "on"，若不需要则不传值; 6. 三方校验规则，比如传入空字符串。	disabled
fileRuleRegexes	array[string]	该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制。	\.java$
thirdPartyTimeout	integer	仅作用于第三方校验规则，默认的超时时间为1000ms，第三方校验服务的耗时尽可能不要超过1秒，也不建议将超时时间调大。	0
thirdPartyUrl	string	仅作用于三方校验规则，表示三方校验地址；如果 codeup 后端服务到第三方服务网络不通，则会调用失败，这是常见问题。	""
updatedAt	string	更新时间。	2023-01-03T15:41:26+08:00

返回示例

{
    "createdAt": "2023-01-03T15:41:26+08:00",
    "id": 2077,
    "ruleInfos": [
        {
            "checkerName": "ForcePushChecker",
            "checkerType": "warn",
            "extraMessage": "disabled",
            "fileRuleRegexes": [
                "\.java$"
            ],
            "thirdPartyTimeout": 0,
            "thirdPartyUrl": ""
        }
    ],
    "updatedAt": "2023-01-03T15:41:26+08:00"
}

错误码

访问错误码中心查看 API 相关错误码。