# Hủy lượt chạy

> operationId: `cancelRun`


## Yêu cầu

Hủy một lượt chạy. Phần thân yêu cầu là {}. Không cần If-Match hay bản sửa đổi danh mục. Nếu lượt chạy đã ở trạng thái kết thúc, trạng thái hiện tại sẽ được trả về và success không bị đổi thành cancelled. cancel_requested không đồng nghĩa với cancelled. Không thể buộc giải phóng một môi trường đang bị cách ly để bắt đầu lại lượt chạy.

- **Điều kiện tiên quyết**: Chỉ hủy các lượt chạy do tài khoản/nhóm hiện tại bắt đầu và bạn vẫn có quyền truy cập.
- **Xác thực truy cập**: Giống như ở các phần khác của Local API; xem [Xác thực](/vi/api-reference/getting-started/authentication). Tài nguyên thuộc phạm vi dữ liệu của tài khoản/nhóm hiện tại.
- **Tác dụng phụ**: Đăng ký ý định hủy và bắt đầu giám sát quá trình dừng. Các hành động đã diễn ra trên trang web không được hoàn tác.
- **Tín hiệu hoàn tất**: 202 nghĩa là yêu cầu hủy đã được đăng ký. Chỉ bằng chứng dừng xuất hiện sau đó và trạng thái cách ly mới cho biết trình duyệt có thể được dùng lại hay không.
- **Thử lại**: Khôi phục cùng ý định bằng khóa ban đầu, phần thân ban đầu (nếu có) và If-Match ban đầu (nếu endpoint này yêu cầu). Khi hết thời gian chờ HTTP, trước tiên hãy [lấy biên nhận yêu cầu](/vi/browser-rpa/api/get-request-receipt). Không tạo khóa mới.


### Endpoint

```http
POST /api/rpa/browser/v1/runs/{runId}/cancel
```

Local API: `http://127.0.0.1:<port>/api/rpa/browser/v1/runs/{runId}/cancel`. Dùng cổng được cấu hình trong ứng dụng.

### Header

| Tham số | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `Authorization` | string | Khi bật xác thực Local API | Xem [Xác thực](/vi/api-reference/getting-started/authentication). |
| `Idempotency-Key` | string | Không | Khuyến nghị. Tạo một UUID cho mỗi ý định ghi mới và giữ nguyên UUID đó khi thử lại sau khi mất kết nối; cùng một khóa không bao giờ được thực thi hai lần. Nếu không có header này thì không có cơ chế chống trùng lặp, nên việc thử lại sau khi hết thời gian chờ có thể thực hiện lại thao tác ghi. Nếu có, giá trị phải là UUID. Định dạng "uuid". |


Kiểu nội dung: `Content-Type: application/json` (bắt buộc).

### Tham số đường dẫn

| Tham số | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `runId` | string | Có | ID của lượt chạy. Độ dài tối thiểu 1; độ dài tối đa 128. |


### Tham số truy vấn

Không có.

### Phần thân yêu cầu

Kiểu: object.

### Ví dụ yêu cầu

Đây là ví dụ minh họa trong tài liệu; ví dụ này chưa được gửi tới một ứng dụng đang chạy thực tế. Đặt `RPA_BASE_URL` theo mô tả trong [Quy ước API](/vi/browser-rpa/api/common). Các biến tài nguyên, bản sửa đổi danh mục và ETag lấy từ phản hồi thực tế.

Lưu toàn bộ JSON dưới đây thành `cancel-run.request.json`. Thay mọi giá trị có định danh chứa `example` bằng giá trị từ phản hồi thực tế. ID nút trong ví dụ tạo mẫu là ID cục bộ trong phạm vi quy trình và có thể giữ nguyên.

```json
{}
```

```bash
curl -i -X POST "${RPA_BASE_URL}/runs/${RPA_RUN_ID}/cancel" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: ${RPA_REQUEST_KEY}" \
  --data-binary @cancel-run.request.json
```

## Phản hồi

### 202

202 nghĩa là yêu cầu hủy đã được đăng ký. Chỉ bằng chứng dừng xuất hiện sau đó và trạng thái cách ly mới cho biết trình duyệt có thể được dùng lại hay không.

Phần thân: `application/json`. Trường `data` ở cấp cao nhất dùng mô hình bên dưới. Về `meta`, xem [Metadata](/vi/browser-rpa/api/data-types#metadata).

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `id` | string | Có | ID duy nhất của tài nguyên hoặc nút. Lấy ID từ phản hồi trước đó; không tự đoán. Độ dài tối thiểu 1; độ dài tối đa 128. |
| `status` | [RunStatus](/vi/browser-rpa/api/data-types#runstatus) | Có | Trạng thái hiện tại. Đối chiếu với các giá trị enum của mô hình. |
| `template` | object | Có | Toàn bộ phần thân của mẫu đề xuất, hoặc bản tóm tắt mẫu được cố định cho lượt chạy. Đọc trường này theo mô hình chứa nó. |
| `environment` | object | Có | Bản tóm tắt môi trường đích được cố định cho lượt chạy. |
| `createdAt` | integer | Có | Thời điểm tạo, tính bằng mili giây Unix. Tối thiểu 0. |
| `startedAt` | integer hoặc null | Có | Thời điểm bắt đầu. Là null cho đến khi lượt chạy bắt đầu (luôn có trong bản ghi nút). |
| `endedAt` | integer hoặc null | Có | Thời điểm kết thúc. Là null cho đến khi lượt chạy kết thúc. |
| `startAfter` | integer hoặc null | Có | Thời điểm bắt đầu sớm nhất, tính bằng mili giây Unix, khi tác vụ của mẫu được đặt bắt đầu trễ. Trước thời điểm đó, lượt chạy ở trạng thái queued và không chiếm dụng môi trường. Là null khi không có độ trễ hoặc với lượt chạy gỡ lỗi. |
| `hasNodeErrors` | boolean | Có | Cho biết có lỗi nút nào xảy ra hay không. Không chỉ xem trạng thái tổng thể mà bỏ qua trường này. |
| `isolation` | object hoặc null | Có | Trạng thái cách ly của môi trường, hoặc null. Không thể dùng lại môi trường đang bị cách ly. |


**Các trường của `template`**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `template.id` | string | Có | ID duy nhất của tài nguyên hoặc nút. Lấy ID từ phản hồi trước đó; không tự đoán. Độ dài tối thiểu 1; độ dài tối đa 128. |
| `template.title` | string | Có | Tên hiển thị. Khi ghi mẫu, dài 1–100 ký tự sau khi loại bỏ khoảng trắng ở hai đầu. |
| `template.version` | integer | Có | Phiên bản mẫu có thể chỉnh sửa hiện tại. Đọc giá trị này từ phản hồi thực tế. Tối thiểu 1. |
| `template.revisionId` | string | Có | ID bản sửa đổi bất biến. Độ dài tối thiểu 1; độ dài tối đa 128. |


**Các trường của `environment`**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `environment.id` | string | Có | ID duy nhất của tài nguyên hoặc nút. Lấy ID từ phản hồi trước đó; không tự đoán. Độ dài tối thiểu 1; độ dài tối đa 128. |
| `environment.name` | string | Có | Tên công khai. |


**Các trường của `isolation`**

| Trường | Kiểu | Bắt buộc | Mô tả và ràng buộc |
|  --- | --- | --- | --- |
| `isolation.state` | `quarantined` / `released` | Có | Trạng thái cách ly của môi trường: quarantined hoặc released. |
| `isolation.reason` | string | Có | Lý do không khả dụng, lý do cách ly hoặc lý do cần kiểm tra khi chạy. |
| `isolation.since` | integer | Có | Thời điểm bắt đầu cách ly, tính bằng mili giây Unix. Tối thiểu 0. |
| `isolation.releasedAt` | integer hoặc null | Có | Thời điểm giải phóng. Là null nếu môi trường chưa được giải phóng. |


### Ví dụ phản hồi

Mọi ID, dấu thời gian, giá trị băm và kết quả lượt chạy đều là dữ liệu ví dụ. Các giá trị này không cho thấy ví dụ đã được thực thi.

```json
{
  "data": {
    "id": "run_example",
    "status": "cancel_requested",
    "template": {
      "id": "template_example",
      "title": "Read the page URL",
      "version": 1,
      "revisionId": "revision_example_1"
    },
    "environment": {
      "id": "environment_example",
      "name": "Example browser profile"
    },
    "createdAt": 1793318400000,
    "startedAt": null,
    "endedAt": null,
    "startAfter": null,
    "hasNodeErrors": false,
    "isolation": null
  },
  "meta": {
    "requestId": "7d498f20-7bab-4e59-9b05-88daf51230e9",
    "catalogRevision": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}
```

### Phản hồi lỗi

| HTTP | error.code | Cách xử lý |
|  --- | --- | --- |
| 409 | RPA_REQUEST_CONFLICT | Phương thức/đường dẫn/phần thân/If-Match gửi kèm cùng khóa khác với ý định ban đầu. |
| 504 | RPA_REQUEST_TIMEOUT | Lỗi này chỉ có nghĩa là thời gian chờ HTTP đã hết. Trước tiên hãy kiểm tra biên nhận của yêu cầu ban đầu. |


Khi phát lại một thao tác ghi bằng cùng khóa, ETag của phản hồi ban đầu được giữ nguyên (nếu có; ETag này có thể đã cũ). Biên nhận chỉ chứa dữ liệu, không có header phản hồi. Để tiếp tục chỉnh sửa, trước tiên hãy gửi một yêu cầu GET mới; xem [Quy ước API](/vi/browser-rpa/api/common).

Về các lỗi 400/401/403/404/429/5xx thường gặp và các trường mô tả thất bại, xem [Lỗi và khôi phục](/vi/browser-rpa/api/common#l%E1%BB%97i-v%C3%A0-kh%C3%B4i-ph%E1%BB%A5c). Ví dụ phản hồi lỗi (403):

```json
{
  "error": {
    "code": "RPA_PERMISSION_DENIED",
    "message": "The request Host or Origin is not allowed, or the current identity can't access the target environment",
    "retryable": false,
    "issues": [],
    "details": null
  },
  "meta": {
    "requestId": "7d498f20-7bab-4e59-9b05-88daf51230e9",
    "catalogRevision": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}
```

## Liên quan

[Tham chiếu Local API](/vi/browser-rpa/local-api) · [Quy ước API](/vi/browser-rpa/api/common) · [Mô hình dữ liệu](/vi/browser-rpa/api/data-types) · [Cấu trúc quy trình](/vi/browser-rpa/api/workflow) · [Bắt đầu nhanh](/vi/browser-rpa/quickstart)

Cả phản hồi 202 lẫn lần phát lại bằng cùng khóa đều có `Location: /api/rpa/browser/v1/runs/<runId>`. Dùng giá trị này để đọc trạng thái hiện tại.