ML Ops¶
This page outlines the operations, endpoints, parameters, and example requests and responses for the ML Ops.
GET /api/v2/mlops/portablePredictionServerImage/¶
Fetches the latest Portable Prediction Server (PPS) Docker image. The resulting image can be docker-loaded. Since the image can be quite large (14GB+) consider querying its metadata to check the image size in advance and content hash to verify the downloaded image afterwards. In some environments it can HTTP redirect to some other service (like S3 or GCP) using pre-signed URLs.
Code samples¶
# You can also use wget
curl -X GET http://10.97.88.31/api/v2/mlops/portablePredictionServerImage/ \
-H 'Authorization: Bearer {access-token}'
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Download the latest available Portable Prediction Server (PPS) Docker image | None |
| 302 | Found | Redirect to another service for more efficient content download using pre-signed URL | None |
| 404 | Not Found | No PPS images found in the system | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/mlops/portablePredictionServerImage/metadata/¶
Fetches currently active PPS Docker image metadata
Code samples¶
# You can also use wget
curl -X GET http://10.97.88.31/api/v2/mlops/portablePredictionServerImage/metadata/ \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Example responses¶
200 Response
{
"baseImageId": "string",
"created": "2019-08-24T14:15:22Z",
"datarobotRuntimeImageTag": "string",
"dockerImageId": "string",
"filename": "string",
"hash": "string",
"hashAlgorithm": "SHA256",
"imageSize": 0,
"shortDockerImageId": "string"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Available Portable Prediction Server (PPS) image metadata | PPSImageMetadataResponse |
| 404 | Not Found | No PPS images found in the system | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas¶
PPSImageMetadataResponse
{
"baseImageId": "string",
"created": "2019-08-24T14:15:22Z",
"datarobotRuntimeImageTag": "string",
"dockerImageId": "string",
"filename": "string",
"hash": "string",
"hashAlgorithm": "SHA256",
"imageSize": 0,
"shortDockerImageId": "string"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| baseImageId | string | true | Internal base image entity id for troubleshooting purposes | |
| created | string(date-time) | true | ISO formatted image upload date | |
| datarobotRuntimeImageTag | string¦null | false | For internal use only. | |
| dockerImageId | string | true | A Docker image id (immutable, content-based) hash associated with the given image | |
| filename | string | true | The name of the file when the download requested | |
| hash | string | true | Hash of the image content, supposed to be used for verifying content after the download. The algorithm used for hashing is specified in hashAlgorithm field. Note that hash is calculated over compressed image data. |
|
| hashAlgorithm | string | true | An algorithm name used for calculating content hash |
|
| imageSize | integer | true | Size in bytes of the compressed PPS image data | |
| shortDockerImageId | string | true | A 12-chars shortened version of the dockerImageId as shown in 'docker images' command line command output |
Enumerated Values¶
| Property | Value |
|---|---|
| hashAlgorithm | SHA256 |