Kiểm tra tiến trình
API này dùng để kiểm tra trạng thái của một tác vụ, chẳng hạn như quá trình khởi tạo hoặc chỉnh sửa Nebula.
Lưu ý
Khi gọi api này cần interval 1s 1 lần call api để update progress status và message.
HTTP request
- URL:
/api/personalize/v1/partner/nebula-ultra/profiles/jobs/{type} - Method:
GET - Content Type: None
- Response Type: application/json
Tham số header
| Header | Mô tả | Kiểu dữ liệu | Bắt buộc |
|---|---|---|---|
| X-Api-Key | Khóa duy nhất. | string | có |
Tham số đường dẫn (Path Parameters)
| Tên Tham Số | Kiểu Dữ Liệu | Bắt buộc | Mô Tả |
|---|---|---|---|
| type | string | có | Loại tiến trình: - initialize: sử dụng cho api tạo, update, tích hợp, huỷ tích hợp - eod: sử dụng cho api chạy cuối ngày |
Tham Số Truy Vấn (Query Parameters)
| Tên Tham Số | Kiểu Dữ Liệu | Bắt buộc | Mô Tả |
|---|---|---|---|
| externalUserId | string | có | UserId của đối tác. |
| recvWindow | string | không | Thời gian chấp nhận (ms), default: 5000. |
| timestamp | string | có | Unix timestamp (milliseconds). |
| signature | string | có | HMAC-SHA256 signature. |
Phản Hồi (Response)
Response Mẫu
{
"status": 200,
"message": "Success",
"data": {
"status": "SUCCESS",
"message": "Hoàn thành",
"progressStatus": 100
}
}
Chi Tiết Tham Số Response
| Tên Thuộc Tính | Kiểu Dữ Liệu | Mô Tả |
|---|---|---|
| status | number | Mã trạng thái HTTP. |
| message | string | Thông báo kết quả xử lý. |
| data | object (Xem chi tiết) | Dữ liệu trạng thái tác vụ. |
| Tên Thuộc Tính | Kiểu Dữ Liệu | Mô Tả |
|---|---|---|
| status | string | Trạng thái của tác vụ: - SUCCESS: Thành công - ERROR: Lỗi - RUNNING: Đang xử lý |
| message | string | Thông báo mô tả trạng thái. |
| progressStatus | number | Tiến trình hoàn thành của tác vụ (%). |