文档

UpdatePushRule - 更新推送规则

更新指定的推送规则,更新方式为覆盖式更新,若是新增规则项,需要确保原有的也存在,否则会被新内容覆盖。

接口说明

需要代码库管理员以上的权限。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

PUT /api/v4/projects/{repositoryId}/push_rule/{pushRuleId}

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

f0b1e61db5961df5975a93f9129d2513
repositoryIdlong

代码库 ID

2709413
pushRuleIdlong

推送规则 ID

2077
bodyobject

请求 Body

ruleInfosobject []

规则信息列表

checkerNamestring

规则名称,可选值:

  • CommitMessageChecker:提交说明规则
  • CommitAuthorEmailChecker:提交邮箱规则
  • CommitAuthorChecker:提交作者检查
  • CommitCommitterChecker:提交人检查
  • ForcePushChecker:禁止强制推送检查
  • CommitFilesChecker:提交文件限制规则
CommitAuthorChecker
extraMessagestring

在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效:

  • 提交说明规则,extraMessage 传入检查的正则表达式
  • 提交邮箱规则,extraMessage 传入检查的邮箱正则表示
  • 禁止强制推送,extraMessage 传入 "disabled"
  • 检查作者规则,extraMessage 传入 "on",若不需要则不传值
  • 检查提交人规则,extraMessage 传入 "on",若不需要则不传值
on
checkerTypestring

该字段作用于代码属主检查下的限制级别设置,仅检查作者和检查提交者有效,其他规则可不传值,可选值:

  • warn:仅警告,允许推送
  • block:禁止推送
warn
fileRuleRegexesarray

该字段仅作用于提交文件限制,传入正则表达式,支持多条正则限制

string

文件限制正则表达式

\.java$

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCodestring

错误码

Openapi.RequestError
errorMessagestring

错误信息

""
successboolean

请求是否成功

true
resultobject

返回结果

idlong

推送规则 ID

30815
ruleInfosobject []

规则信息列表

checkerNamestring

规则名称,可选值:

  • CommitMessageChecker:提交说明规则
  • CommitAuthorEmailChecker:提交邮箱规则
  • CommitAuthorChecker:提交作者检查
  • CommitCommitterChecker:提交人检查
  • ForcePushChecker:禁止强制推送检查
  • CommitFilesChecker:提交文件限制规则
CommitAuthorChecker
checkerTypestring

该字段作用于代码属主检查下的限制级别设置,仅检查作者和检查提交者有效,其他规则可不传值,可选值:

  • warn:仅警告,允许推送
  • block:禁止推送
warn
extraMessagestring

在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效:

  • 提交说明规则,extraMessage 传入检查的正则表达式
  • 提交邮箱规则,extraMessage 传入检查的邮箱正则表示
  • 禁止强制推送,extraMessage 传入 "disabled"
  • 检查作者规则,extraMessage 传入 "on",若不需要则不传值
  • 检查提交人规则,extraMessage 传入 "on",若不需要则不传值
on
fileRuleRegexesarray

该字段仅作用于提交文件限制,传入正则表达式,支持多条正则限制

string

文件限制正则表达式

\.java$
gmtCreatestring

创建时间

2023-09-03T18:20:06+08:00
gmtModifiedstring

修改时间

2023-09-03T18:20:06+08:00

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorCode": "Openapi.RequestError",
  "errorMessage": "\"\"",
  "success": true,
  "result": {
    "id": 30815,
    "ruleInfos": [
      {
        "checkerName": "CommitAuthorChecker",
        "checkerType": "warn",
        "extraMessage": "on",
        "fileRuleRegexes": [
          "\\.java$"
        ]
      }
    ],
    "gmtCreate": "2023-09-03T18:20:06+08:00",
    "gmtModified": "2023-09-03T18:20:06+08:00"
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈