Jump to

• Request
• Response

(Preview) List model deployment activities

post

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

(Preview) Returns the activity history for a model deployment.

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.

Body ()

Filters and pagination for the activity search.

Root Schema : ListModelDeploymentActivitiesDetails

Type: object

Filters and pagination for a deployment activity search.

Show Source

• deployment_id(required): string
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[0-9a-f]{32}$

  ID of the deployment whose activities to list.
• max_results: integer(int64)
  Minimum Value: 1

  Maximum Value: 1000

  Maximum number of activities desired. Default is 100. Max threshold is 1000.
• order_by: array order_by
  Maximum Number of Items: 10

  List of columns for ordering search results, e.g. 'start_time DESC'.
• page_token: string
  Minimum Length: 1

  Maximum Length: 256

  Token indicating the page of activities to fetch.
• status: string
  Allowed Values: [ "SUCCESS", "FAILURE" ]

  A filter over activity status.

{
    "description":"Filters and pagination for a deployment activity search.",
    "type":"object",
    "required":[
        "deployment_id"
    ],
    "properties":{
        "deployment_id":{
            "description":"ID of the deployment whose activities to list.",
            "type":"string",
            "minLength":32,
            "maxLength":32,
            "pattern":"^[0-9a-f]{32}$"
        },
        "status":{
            "description":"A filter over activity status.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentActivityStatus",
            "enum":[
                "SUCCESS",
                "FAILURE"
            ]
        },
        "max_results":{
            "description":"Maximum number of activities 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. 'start_time DESC'.",
            "type":"array",
            "maxItems":10,
            "items":{
                "type":"string",
                "maxLength":128
            }
        },
        "page_token":{
            "description":"Token indicating the page of activities 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. 'start_time DESC'.

Show Source

• Array of: string
  Maximum Length: 128

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Deployment activity summaries 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.

Body ()

Root Schema : ModelDeploymentActivitySummaryCollection

Type: object

Result of listing deployment activity summaries.

Show Source

• activities(required): array activities
  Activity summaries that match the search criteria.
• next_page_token: string
  Token that can be used to retrieve the next page of activities. An empty token means that no more activities are available for retrieval.

{
    "description":"Result of listing deployment activity summaries.",
    "type":"object",
    "required":[
        "activities"
    ],
    "properties":{
        "activities":{
            "description":"Activity summaries that match the search criteria.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DeploymentActivitySummary"
            }
        },
        "next_page_token":{
            "description":"Token that can be used to retrieve the next page of activities. An empty token means that no more activities are available for retrieval.",
            "type":"string"
        }
    }
}

Nested Schema : activities

Type: array

Activity summaries that match the search criteria.

Show Source

• Array of: object DeploymentActivitySummary
  A deployment activity record for a table listing: the activity fields plus a minimal deployment_details snapshot (model name + served versions). The full configuration snapshot and the message comment are returned only by the single-activity read.

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

Nested Schema : DeploymentActivitySummary

Type: object

A deployment activity record for a table listing: the activity fields plus a minimal deployment_details snapshot (model name + served versions). The full configuration snapshot and the message comment are returned only by the single-activity read.

Show Source

• activity_id(required): string
  ID of the deployment activity.
• deployment_details: object DeploymentDetailsSummary
  Minimal deployment configuration for a deployment-activity list row: the registered model and the served model versions. The full configuration snapshot is available from the single-activity read.
• end_time(required): string
  Unix timestamp in milliseconds of when the activity ended.
• operation_type(required): string
  Allowed Values: [ "CREATE", "EDIT", "ACTIVATE", "DEACTIVATE", "ROLL_FORWARD", "ROLL_BACK" ]

  Operation type of the activity.
• start_time(required): string
  Unix timestamp in milliseconds of when the activity started.
• status(required): string
  Allowed Values: [ "SUCCESS", "FAILURE" ]

  Status of the activity.
• user(required): string
  User that created the activity.

{
    "description":"A deployment activity record for a table listing: the activity fields plus a minimal deployment_details snapshot (model name + served versions). The full configuration snapshot and the message comment are returned only by the single-activity read.",
    "type":"object",
    "required":[
        "activity_id",
        "operation_type",
        "status",
        "start_time",
        "end_time",
        "user"
    ],
    "properties":{
        "activity_id":{
            "description":"ID of the deployment activity.",
            "type":"string"
        },
        "operation_type":{
            "description":"Operation type of the activity.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentOperationType",
            "enum":[
                "CREATE",
                "EDIT",
                "ACTIVATE",
                "DEACTIVATE",
                "ROLL_FORWARD",
                "ROLL_BACK"
            ]
        },
        "status":{
            "description":"Status of the activity.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentActivityStatus",
            "enum":[
                "SUCCESS",
                "FAILURE"
            ]
        },
        "start_time":{
            "description":"Unix timestamp in milliseconds of when the activity started.",
            "type":"string"
        },
        "end_time":{
            "description":"Unix timestamp in milliseconds of when the activity ended.",
            "type":"string"
        },
        "user":{
            "description":"User that created the activity.",
            "type":"string"
        },
        "deployment_details":{
            "$ref":"#/definitions/DeploymentDetailsSummary"
        }
    }
}

Nested Schema : DeploymentDetailsSummary

Type: object

Minimal deployment configuration for a deployment-activity list row: the registered model and the served model versions. The full configuration snapshot is available from the single-activity read.

Show Source

• deployment_targets: array deployment_targets
  Model versions served by the deployment and their traffic share.
• model_name: string
  Name of the registered model.

{
    "description":"Minimal deployment configuration for a deployment-activity list row: the registered model and the served model versions. The full configuration snapshot is available from the single-activity read.",
    "type":"object",
    "properties":{
        "model_name":{
            "description":"Name of the registered model.",
            "type":"string"
        },
        "deployment_targets":{
            "description":"Model versions served by the deployment and their traffic share.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DeploymentTarget"
            }
        }
    }
}

Nested Schema : deployment_targets

Type: array

Model versions served by the deployment and their traffic share.

Show Source

• Array of: object DeploymentTarget
  A model version targeted by a deployment and its traffic share.

{
    "description":"Model versions served by the deployment and their traffic share.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DeploymentTarget"
    }
}

Nested Schema : DeploymentTarget

Type: object

A model version targeted by a deployment and its traffic share.

Show Source

• model_version(required): string
  Minimum Length: 1

  Maximum Length: 30

  Version number of the model version.
• traffic_percentage(required): integer
  Minimum Value: 1

  Maximum Value: 100

  Percentage of deployment traffic routed to this model version.

{
    "description":"A model version targeted by a deployment and its traffic share.",
    "type":"object",
    "required":[
        "model_version",
        "traffic_percentage"
    ],
    "properties":{
        "model_version":{
            "description":"Version number of the model version.",
            "type":"string",
            "minLength":1,
            "maxLength":30
        },
        "traffic_percentage":{
            "description":"Percentage of deployment traffic routed to this model version.",
            "type":"integer",
            "minimum":1,
            "maximum":100
        }
    }
}

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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"
        }
    }
}

Back to Top