GetPushRule - 查询推送规则_云效(Apsara Devops)-阿里云帮助中心

查询指定的推送规则。

接口说明

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

调试

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

调试

授权信息

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

请求语法

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

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx
accessToken	string	否	个人访问令牌。使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段	f0b1e61db5961df5975a93f9129d2513
repositoryId	long	是	代码库 ID	3219116
pushRuleId	long	是	推送规则 ID	2077

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID	F7B85D1B-D1C2-140F-A039-341859F130B9
errorCode	string	错误码	SYSTEM_UNKNOWN_ERROR
errorMessage	string	错误信息	""
success	boolean	调用是否成功	true
result	object	返回结果
id	long	推送规则 ID	2077
ruleInfos	array<object>	规则信息列表
	object	规则信息
checkerName	string	规则名称，可选值： CommitMessageChecker：提交说明规则 CommitAuthorEmailChecker：提交邮箱规则 CommitAuthorChecker：提交作者检查 CommitCommitterChecker：提交人检查 ForcePushChecker：禁止强制推送检查 CommitFilesChecker：提交文件限制规则	CommitAuthorChecker
checkerType	string	该字段作用于代码属主检查下的限制级别设置，仅检查作者和检查提交者有效，其他规则可不传值，可选值： warn：仅警告，允许推送 block：禁止推送	warn
extraMessage	string	在提交说明、提交邮箱、检查作者、检查提交人以及禁止强制推送时有效：提交说明规则，extraMessage 传入检查的正则表达式提交邮箱规则，extraMessage 传入检查的邮箱正则表示禁止强制推送，extraMessage 传入 "disabled" 检查作者规则，extraMessage 传入 "on"，若不需要则不传值检查提交人规则，extraMessage 传入 "on"，若不需要则不传值	on
fileRuleRegexes	array	该字段仅作用于提交文件限制，传入正则表达式，支持多条正则限制
	string	文件限制正则表达式	\.java$
gmtCreate	string	创建时间	2023-09-03T18:20:06+08:00
gmtModified	string	更新时间	2023-09-03T18:20:06+08:00

示例

正常返回示例

JSON格式

{
  "requestId": "F7B85D1B-D1C2-140F-A039-341859F130B9",
  "errorCode": "SYSTEM_UNKNOWN_ERROR",
  "errorMessage": "\"\"",
  "success": true,
  "result": {
    "id": 2077,
    "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"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史