Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. Mass Ingestion Streaming REST API
  8. Model Serve REST API
  9. RunAJob utility
  10. ParamSetCli utility
  11. REST API codes
  12. REST API resource quick references

REST API Reference

REST API Reference

Starting and stopping a quick start model or model deployment

Starting and stopping a quick start model or model deployment

Use the control resource to start, restart, and stop a quick start model or a model deployment.

POST request

To start, restart, or stop a deployment, include the deployment ID in the URI.
To start a deployment, use the following URI:
/mlops/api/v1/deployment/control/<deployment ID>/start
To restart a deployment, use the following URI:
/mlops/api/v1/deployment/control/<deployment ID>/restart
To stop a deployment, use the following URI:
/mlops/api/v1/deployment/control/<deployment ID>/stop
Get the ID for a quick start model from the response to get information about a single quick start model. For more information, see Getting information about a quick start model.
Get the deployment ID for a model deployment from the response to monitor a model deployment. For more information, see Monitoring model deployments.
To start a quick start model through an API request, you must first start it at least once through the user interface.

POST response

Returns the deployment object.
The following table describes the fields in a deployment object:
Field
Description
deploymentID
ID of the quick start model or model deployment.
state
Requested state of the deployment. When you start or restart the deployment, the state is
ENABLED
. When you stop the deployment, the state is
DISABLED
.
status
Current status of the deployment.
message
Warning or error message string.
Applies only if a warning or error occurs.
startedByUserID
ID of the user that last started the deployment.
startedbyUserName
Name of the user that last started the deployment.
startTime
Time that the deployment started, in milliseconds from the UNIX epoch, 00:00:00 UTC on January 1, 1970.
stopTime
Time that the deployment stopped, in milliseconds from the UNIX epoch.
Applies only when you stop the deployment.
updateTime
Time that the deployment status was last updated, in milliseconds from the UNIX epoch.

0 COMMENTS

We’d like to hear from you!