REST Data Plane APIs for Oracle AI Data Platform

(Preview) Search model deployments

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/model-deployments/search

(Preview) Returns a list of model deployments matching the given criteria.

Request

Path Parameters

aiDataPlatformId(required): string

Minimum Length: 1

Maximum Length: 500

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.

Header Parameters

opc-request-id: string

Maximum Length: 255

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Filters and pagination for the search.

Root Schema : SearchModelDeploymentsDetails

Type: object

Filters and pagination for a model deployment search.

Show Source

max_results: integer(int64)

Minimum Value: 1

Maximum Value: 1000

Maximum number of deployments desired. Default is 100. Max threshold is 1000.
model_name(required): string

Minimum Length: 1

Maximum Length: 256

A filter over the registered model name.
order_by: array order_by

Maximum Number of Items: 10

List of columns for ordering search results, e.g. 'created_time DESC'.
page_token: string

Minimum Length: 1

Maximum Length: 256

Token indicating the page of deployments to fetch.
status: string

Allowed Values: [ "INACTIVE", "ACTIVATING", "ACTIVE", "DEACTIVATING", "UPDATING" ]

A filter over deployment status.

{
    "description":"Filters and pagination for a model deployment search.",
    "type":"object",
    "required":[
        "model_name"
    ],
    "properties":{
        "model_name":{
            "description":"A filter over the registered model name.",
            "type":"string",
            "minLength":1,
            "maxLength":256
        },
        "status":{
            "description":"A filter over deployment status.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentStatus",
            "enum":[
                "INACTIVE",
                "ACTIVATING",
                "ACTIVE",
                "DEACTIVATING",
                "UPDATING"
            ]
        },
        "max_results":{
            "description":"Maximum number of deployments desired. Default is 100. Max threshold is 1000.",
            "type":"integer",
            "format":"int64",
            "minimum":1,
            "maximum":1000
        },
        "order_by":{
            "description":"List of columns for ordering search results, e.g. 'created_time DESC'.",
            "type":"array",
            "maxItems":10,
            "items":{
                "type":"string",
                "maxLength":128
            }
        },
        "page_token":{
            "description":"Token indicating the page of deployments to fetch.",
            "type":"string",
            "minLength":1,
            "maxLength":256
        }
    }
}

Nested Schema : order_by

Type: array

Maximum Number of Items: 10

List of columns for ordering search results, e.g. 'created_time DESC'.

Show Source

Array of: string

Maximum Length: 128

{
    "description":"List of columns for ordering search results, e.g. 'created_time DESC'.",
    "type":"array",
    "maxItems":10,
    "items":{
        "type":"string",
        "maxLength":128
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation. Model deployments are retrieved.

Headers

opc-next-page: string

For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : ModelDeploymentCollection

Type: object

Result of searching model deployments.

Show Source

deployments(required): array deployments

Deployments that match the search criteria.
next_page_token: string

Token that can be used to retrieve the next page of deployments. An empty token means that no more deployments are available for retrieval.

{
    "description":"Result of searching model deployments.",
    "type":"object",
    "required":[
        "deployments"
    ],
    "properties":{
        "deployments":{
            "description":"Deployments that match the search criteria.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ModelDeploymentSummary"
            }
        },
        "next_page_token":{
            "description":"Token that can be used to retrieve the next page of deployments. An empty token means that no more deployments are available for retrieval.",
            "type":"string"
        }
    }
}

Nested Schema : deployments

Type: array

Deployments that match the search criteria.

Show Source

Array of: object ModelDeploymentSummary

Summary of a model deployment returned by a search.

{
    "description":"Deployments that match the search criteria.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ModelDeploymentSummary"
    }
}

Nested Schema : ModelDeploymentSummary

Type: object

Summary of a model deployment returned by a search.

Show Source

activated_by: string

User that activated the model deployment.
activated_time: integer(int64)

Unix timestamp in milliseconds of when the deployment was activated.
created_by(required): string

User that created the model deployment.
created_time(required): string

Unix timestamp in milliseconds of when the deployment was created.
deployment_id(required): string

ID of the deployment.
description: string

Description of the deployment.
model_name(required): string

Name of the registered model.
name(required): string

Name of the deployment.
serving_uri: string

Maximum Length: 1000

Serving URI of the deployment.
status(required): string

Allowed Values: [ "INACTIVE", "ACTIVATING", "ACTIVE", "DEACTIVATING", "UPDATING" ]

Status of the deployment.
updated_by(required): string

User that last updated the model deployment.
updated_time(required): string

Unix timestamp in milliseconds of when the deployment was updated.

{
    "description":"Summary of a model deployment returned by a search.",
    "type":"object",
    "required":[
        "deployment_id",
        "name",
        "model_name",
        "status",
        "created_by",
        "created_time",
        "updated_time",
        "updated_by"
    ],
    "properties":{
        "deployment_id":{
            "description":"ID of the deployment.",
            "type":"string"
        },
        "name":{
            "description":"Name of the deployment.",
            "type":"string"
        },
        "description":{
            "description":"Description of the deployment.",
            "type":"string"
        },
        "model_name":{
            "description":"Name of the registered model.",
            "type":"string"
        },
        "status":{
            "description":"Status of the deployment.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentStatus",
            "enum":[
                "INACTIVE",
                "ACTIVATING",
                "ACTIVE",
                "DEACTIVATING",
                "UPDATING"
            ]
        },
        "created_by":{
            "description":"User that created the model deployment.",
            "type":"string"
        },
        "created_time":{
            "description":"Unix timestamp in milliseconds of when the deployment was created.",
            "type":"string"
        },
        "activated_time":{
            "description":"Unix timestamp in milliseconds of when the deployment was activated.",
            "type":"integer",
            "format":"int64"
        },
        "activated_by":{
            "description":"User that activated the model deployment.",
            "type":"string"
        },
        "serving_uri":{
            "description":"Serving URI of the deployment.",
            "type":"string",
            "maxLength":1000
        },
        "updated_time":{
            "description":"Unix timestamp in milliseconds of when the deployment was updated.",
            "type":"string"
        },
        "updated_by":{
            "description":"User that last updated the model deployment.",
            "type":"string"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

opc-request-id: string

Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}