dragonfly/docs/en/preheat/api.md

API

Use preheat apis for preheating. First create a POST request for preheating, you can refer to create preheat api document

If the scheduler_cluster_id does not exist, it means to preheat all scheduler clusters.

curl --request POST 'http://dragonfly-manager:8080/api/v1/preheats' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "image",
    "url": "https://registry-1.docker.io/v2/library/busybox/manifests/latest",
    "scheduler_cluster_id": 1
}'

If the output of command above has content like

{"id":"group_28439e0b-d4c3-43bf-945e-482b54c49dc5","status":"PENDING","create_at":"2021-10-09T11:54:50.6182794Z"}

Polling the preheating status with id. if status is SUCCESS, preheating is successful, you can refer to get preheat api document

curl --request GET 'http://dragonfly-manager:8080/api/v1/preheats/group_28439e0b-d4c3-43bf-945e-482b54c49dc5'

If the status is SUCCESS, the preheating is successful.

{"id":"group_28439e0b-d4c3-43bf-945e-482b54c49dc5","status":"SUCCESS","create_at":"2021-10-09T11:54:50.5712334Z"}