Lấy trạng thái tất cả công việc

1. Tổng quan

Endpoint https://api.revidapi.com/paid/get/all/jobs/id/status là một phần của Toolkit API và được sử dụng để lấy trạng thái của tất cả các công việc trong một khoảng thời gian được chỉ định. Endpoint này phù hợp với cấu trúc API tổng thể bằng cách cung cấp cách để giám sát và quản lý các công việc đã được gửi đến hệ thống.

2. Endpoint

URL Path: https://api.revidapi.com/paid/get/all/jobs/id/status HTTP Method: POST

3. Yêu cầu

Headers

x-api-key (bắt buộc): API key để xác thực.

Tham số Body

since_seconds (tùy chọn, number): Số giây để nhìn lại các công việc. Nếu không được cung cấp, giá trị mặc định là 600 giây (10 phút).

Payload JSON hoàn toàn tùy chọn. Nếu không cung cấp payload hoặc payload trống, endpoint sẽ sử dụng giá trị mặc định là 600 giây.

Ví dụ yêu cầu

{
    "since_seconds": 3600
}

Hoặc không có body:

curl -X POST \
     -H "x-api-key: YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.revidapi.com/paid/get/all/jobs/id/status

Với body:

curl -X POST \
     -H "x-api-key: YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"since_seconds": 3600}' \
     http://your-api-url/v1/toolkit/jobs/status

4. Phản hồi

Phản hồi thành công

Phản hồi sẽ là đối tượng JSON chứa trạng thái công việc cho tất cả các công việc trong khoảng thời gian được chỉ định. Định dạng phản hồi tuân theo cấu trúc phản hồi chung được định nghĩa trong app.py.

{
    "code": 200,
    "id": null,
    "job_id": "job_id_value",
    "response": {
        "job_id_1": "job_status_1",
        "job_id_2": "job_status_2",
        ...
    },
    "message": "success",
    "run_time": 0.123,
    "queue_time": 0,
    "total_time": 0.123,
    "pid": 12345,
    "queue_id": 1234567890,
    "queue_length": 0,
    "build_number": "1.0.0"
}

Phản hồi lỗi

404 Not Found: Nếu không tìm thấy thư mục công việc.

{
    "code": 404,
    "id": null,
    "job_id": "job_id_value",
    "response": null,
    "message": "Jobs directory not found",
    "run_time": 0.123,
    "queue_time": 0,
    "total_time": 0.123,
    "pid": 12345,
    "queue_id": 1234567890,
    "queue_length": 0,
    "build_number": "1.0.0"
}

500 Internal Server Error: Nếu có ngoại lệ xảy ra khi lấy trạng thái công việc.

{
    "code": 500,
    "id": null,
    "job_id": "job_id_value",
    "response": null,
    "message": "Failed to retrieve job statuses: Error message",
    "run_time": 0.123,
    "queue_time": 0,
    "total_time": 0.123,
    "pid": 12345,
    "queue_id": 1234567890,
    "queue_length": 0,
    "build_number": "1.0.0"
}

5. Xử lý lỗi

Thiếu hoặc header x-api-key không hợp lệ: Decorator authenticate sẽ trả về lỗi 401 Unauthorized.
Không tìm thấy thư mục công việc: Endpoint sẽ trả về lỗi 404 Not Found nếu không tìm thấy thư mục công việc.
Ngoại lệ trong quá trình lấy trạng thái công việc: Endpoint sẽ trả về lỗi 500 Internal Server Error nếu có ngoại lệ xảy ra khi lấy trạng thái công việc.

Tệp app.py chính bao gồm xử lý lỗi cho tình huống tràn hàng đợi (429 Too Many Requests) và ghi nhật ký trạng thái công việc (queued, running, done) bằng hàm log_job_status.

6. Ghi chú sử dụng

Endpoint này hữu ích để giám sát trạng thái của các công việc đã được gửi đến hệ thống, đặc biệt khi làm việc với các công việc chạy lâu hoặc được đưa vào hàng đợi.
Tham số since_seconds có thể được điều chỉnh để lấy trạng thái công việc trong một khoảng thời gian cụ thể, cho phép giám sát có mục tiêu hơn.

7. Vấn đề thường gặp

Cung cấp header x-api-key không hợp lệ sẽ dẫn đến lỗi xác thực.
Nếu không tìm thấy thư mục công việc hoặc có ngoại lệ xảy ra khi lấy trạng thái công việc, endpoint sẽ trả về lỗi.

8. Thực hành tốt nhất

Luôn bao gồm header x-api-key với API key hợp lệ để xác thực.
Giám sát trạng thái công việc thường xuyên để theo dõi tiến trình và hoàn thành của các công việc đã được gửi.
Điều chỉnh tham số since_seconds dựa trên yêu cầu giám sát của bạn để lấy trạng thái công việc trong một khoảng thời gian cụ thể.
Triển khai cơ chế xử lý lỗi và ghi nhật ký để theo dõi và khắc phục sự cố bất kỳ vấn đề nào có thể phát sinh.