Chuyển tới nội dung chính

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​

HeaderMô tảKiểu dữ liệuBắt buộc
X-Api-KeyKhóa duy nhất.stringcó

Tham số đường dẫn (Path Parameters)​

Tên Tham SốKiểu Dữ LiệuBắt buộcMô Tả
typestringcó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ệuBắt buộcMô Tả
externalUserIdstringcóUserId của đối tác.
recvWindowstringkhôngThời gian chấp nhận (ms), default: 5000.
timestampstringcóUnix timestamp (milliseconds).
signaturestringcó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ínhKiểu Dữ LiệuMô Tả
statusnumberMã trạng thái HTTP.
messagestringThông báo kết quả xử lý.
dataobject (Xem chi tiết)Dữ liệu trạng thái tác vụ.

Cấu trúc thuộc tính data​

Quay lại
Tên Thuộc TínhKiểu Dữ LiệuMô Tả
statusstringTrạng thái của tác vụ:
- SUCCESS: Thành công
- ERROR: Lỗi
- RUNNING: Đang xử lý
messagestringThông báo mô tả trạng thái.
progressStatusnumberTiến trình hoàn thành của tác vụ (%).

CREDENTIALS▼

* Timestamp và Signature sẽ được tự động tạo khi gọi API

RESPONSE200

{
"status": 200,
"message": "Success",
"data": {
"status": "SUCCESS",
"message": "Hoàn thành",
"progressStatus": 100
}
}