start-trained-model-deployment.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[start-trained-model-deployment]]
  4. = Start trained model deployment API
  5. [subs="attributes"]
  6. ++++
  7. <titleabbrev>Start trained model deployment</titleabbrev>
  8. ++++
  9. [[start-trained-model-deployment-request]]
  10. == {api-request-title}
  11. `POST _ml/trained_models/<model_id>/deployent/_start`
  12. ////
  13. [[start-trained-model-deployment-prereq]]
  14. == {api-prereq-title}
  15. ////
  16. ////
  17. [[start-trained-model-deployment-desc]]
  18. == {api-description-title}
  19. ////
  20. [[start-trained-model-deployment-path-params]]
  21. == {api-path-parms-title}
  22. `<model_id>`::
  23. (Required, string)
  24. include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-id]
  25. [[start-trained-model-deployment-query-params]]
  26. == {api-query-parms-title}
  27. `timeout`::
  28. (Optional, time)
  29. Controls the amount of time to wait for the model to deploy. Defaults
  30. to 20 seconds.
  31. ////
  32. [role="child_attributes"]
  33. [[start-trained-model-deployment-results]]
  34. == {api-response-body-title}
  35. ////
  36. ////
  37. [[ml-get-trained-models-response-codes]]
  38. == {api-response-codes-title}
  39. ////
  40. ////
  41. [[start-trained-model-deployment-example]]
  42. == {api-examples-title}
  43. ////