UpdatePushRule - 更新推送規則 - Alibaba Cloud DevOps

通過 OpenAPI 更新推送規則。

服務存取點與授權資訊

擷取服務存取點：替換 API 請求文法中的 {domain} 。
擷取個人存取權杖。

產品	資源	要求的權限
代碼管理	推送規則	讀寫

請求文法

Region版

PUT https://{domain}/oapi/v1/codeup/repositories/{repositoryId}/pushRules/{pushRuleId}

要求標頭

參數	類型	是否必填	描述	樣本值
x-yunxiao-token	string	是	個人存取權杖。	pt-0fh3**0fbG_35af**0484

請求參數

參數	類型	位置	是否必填	描述	樣本值
repositoryId	string	path	是	程式碼程式庫 ID 或者 URL-Encoder 編碼的全路徑。	2813489或者60de7a6852743a5162b5f957%2FDemoRepo
pushRuleId	integer	path	是	推送規則 ID。	1
-	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 傳入檢查的Regex; 2.提交郵箱規則，extraMessage 傳入檢查的郵箱正則表示; 3.禁止強制推送，extraMessage 傳入 "disabled"; 4.檢查作者規則，extraMessage 傳入 "on"，若不需要則不傳值; 5.檢查提交人規則，extraMessage 傳入 "on"，若不需要則不傳值; 6. 三方校正規則，比如傳入Null 字元串。	username@example.com
fileRuleRegexes	array[string]	body	否	該欄位僅作用於提交檔案限制，傳入Regex，支援多條正則限制。	["*.java"]
thirdPartyTimeout	integer	body	否	僅作用於三方校正規則，預設的逾時時間為1000ms，三方校正服務的耗時儘可能不要超過1秒，也不建議將逾時調大。	1000
thirdPartyUrl	string	body	否	僅作用於三方校正規則，表示三方校正地址；如果 codeup 後端服務到第三方服務網路不通，則會調用失敗，這是常見問題。	http://example.com/test

請求樣本

Region版

curl -X 'PUT' \
  'https://{domain}/oapi/v1/codeup/repositories/2813489或者60de7a6852743a5162b5f957%2FDemoRepo/pushRules/1' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "ruleInfos": [
            {
                "checkerName": "CommitMessageChecker",
                "checkerType": "warn",
                "extraMessage": "username@example.com",
                "fileRuleRegexes": ["*.java"],
                "thirdPartyTimeout": 1000,
                "thirdPartyUrl": "http://example.com/test"
            }
        ]
    }'

返回參數

參數	類型	描述	樣本值
-	object
createdAt	string	建立時間。	2024-10-05T15:30:45Z
id	integer	推送規則主鍵 ID。	1
ruleInfos	array	規則資訊列表。
-	object
checkerName	string	規則名稱，可為: CommitMessageChecker - 提交說明規則；CommitAuthorEmailChecker - 提交郵箱規則；CommitAuthorChecker - 提交作者檢查；CommitCommitterChecker - 提交人檢查；ForcePushChecker - 強制推送檢查；CommitFilesChecker - 提交檔案限制規則；ThirdPartyChecker - 三方校正規則。	CommitMessageChecker
checkerType	string	限制層級設定：warn - 僅警告，允許推送，block - 禁止推送。	warn
extraMessage	string	在提交說明、提交郵箱、檢查作者、檢查提交人以及禁止強制推送時有效：1.提交說明規則，extraMessage 傳入檢查的Regex; 2.提交郵箱規則，extraMessage 傳入檢查的郵箱正則表示; 3.禁止強制推送，extraMessage 傳入 "disabled"; 4.檢查作者規則，extraMessage 傳入 "on"，若不需要則不傳值; 5.檢查提交人規則，extraMessage 傳入 "on"，若不需要則不傳值; 6. 三方校正規則，比如傳入Null 字元串。	username@example.com
fileRuleRegexes	array[string]	該欄位僅作用於提交檔案限制，傳入Regex，支援多條正則限制。	["*.java"]
thirdPartyTimeout	integer	僅作用於三方校正規則，預設的逾時時間為1000ms，三方校正服務的耗時儘可能不要超過1秒，也不建議將逾時調大。	1000
thirdPartyUrl	string	僅作用於三方校正規則，表示三方校正地址；如果 codeup 後端服務到第三方服務網路不通，則會調用失敗，這是常見問題。	http://example.com/test
updatedAt	string	更新時間。	2024-10-05T15:30:45Z

返回樣本

{
    "createdAt": "2024-10-05T15:30:45Z",
    "id": 1,
    "ruleInfos": [
        {
            "checkerName": "CommitMessageChecker",
            "checkerType": "warn",
            "extraMessage": "username@example.com",
            "fileRuleRegexes": ["*.java"],
            "thirdPartyTimeout": 1000,
            "thirdPartyUrl": "http://example.com/test"
        }
    ],
    "updatedAt": "2024-10-05T15:30:45Z"
}

錯誤碼

訪問錯誤碼中心查看 API 相關錯誤碼。