Cancel run
POST
/api/automation/runs/{runId}/cancelQuản trị viên
Tham số đường dẫn
| Tên | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
runId | string (uuid) | Bắt buộc |
Response
Thành công: 200
| Trường | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
id | string (uuid) | Tùy chọn | |
ruleId | string (uuid) | Tùy chọn | |
ruleName | string | Tùy chọn | |
releaseId | string (uuid) | Tùy chọn | |
releaseVersion | string | Tùy chọn | |
triggerType | enum TriggerType | Tùy chọn | RELEASE_PUBLISHEDMANUALSCHEDULED_CRONUPCOMING_RELEASE_REMINDEREXTERNAL_WEBHOOK |
requestId | string (uuid) | Tùy chọn | |
initiatorName | string | Tùy chọn | |
status | enum ExecutionStatus | Tùy chọn | PENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED |
cancellationRequested | boolean | Tùy chọn | |
createdAt | string (date-time) | Tùy chọn | |
startedAt | string (date-time) | Tùy chọn | |
completedAt | string (date-time) | Tùy chọn | |
actions | array of AutomationActionRunView | Tùy chọn | |
actions[].id | string (uuid) | Tùy chọn | |
actions[].position | integer | Tùy chọn | |
actions[].actionType | enum ActionType | Tùy chọn | GITHUB_RELEASESLACKEMAILPUBLIC_CHANGELOGNOTIONCONFLUENCEMICROSOFT_TEAMSZENDESK |
actions[].audienceName | string | Tùy chọn | |
actions[].language | string | Tùy chọn | |
actions[].status | enum ExecutionStatus | Tùy chọn | PENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED |
actions[].externalReference | string | Tùy chọn | |
actions[].errorCode | string | Tùy chọn | |
actions[].attempts | integer | Tùy chọn | |
actions[].startedAt | string (date-time) | Tùy chọn | |
actions[].completedAt | string (date-time) | Tùy chọn |
Lỗi
| Trạng thái | Mã | Áp dụng cho |
|---|---|---|
400 | validation_failedthiếu trường hoặc giá trị nằm ngoài khoảng cho phép | Mọi endpoint |
400 | invalid_parametermột tham số trên đường dẫn hoặc query bị thiếu hoặc không chuyển đổi được, chẳng hạn một ID không phải UUID | Mọi endpoint |
401 | authentication_requiredchưa có phiên đăng nhập | Mọi endpoint |
403 | access_deniedendpoint dành cho quản trị viên, hoặc CSRF token thiếu hay đã cũ | Mọi endpoint |
404 | not_foundkhông có địa chỉ đó | Mọi endpoint |
405 | method_not_allowedđịa chỉ không nhận phương thức đó | Mọi endpoint |
415 | unsupported_media_typeđịa chỉ không đọc body thuộc kiểu đó | Mọi endpoint |
500 | internal_errormột lỗi ReleaseFlow không lường trước; body không bao giờ chứa exception gây ra nó | Mọi endpoint |
400, 404, 409 | Xem hướng dẫn | Khu vực Automation |
Request
bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X POST "http://localhost:8080/api/automation/runs/$RUN_ID/cancel" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN"
Response
200Ví dụ
{
"id": "<uuid>",
"ruleId": "<uuid>",
"ruleName": "<string>",
"releaseId": "<uuid>",
"releaseVersion": "<string>",
"triggerType": "RELEASE_PUBLISHED",
"requestId": "<uuid>",
"initiatorName": "<string>",
"status": "PENDING",
"cancellationRequested": false,
"createdAt": "<date-time>",
"startedAt": "<date-time>",
"completedAt": "<date-time>",
"actions": [
{
"id": "<uuid>",
"position": 0,
"actionType": "GITHUB_RELEASE",
"audienceName": "<string>",
"language": "<string>",
"status": "PENDING",
"externalReference": "<string>",
"errorCode": "<string>",
"attempts": 0,
"startedAt": "<date-time>",
"completedAt": "<date-time>"
}
]
}