Jump to

• Request
• Response

(Preview) Get model deployment activity details

get

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

(Preview) Returns the full detail for a single deployment activity, including the configuration snapshot and the comment.

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.

Query Parameters

• activity_id(required): string
  Minimum Length: 32

  Maximum Length: 32

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

  The unique 32-character hexadecimal ID of the deployment activity to retrieve.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Deployment activity details are retrieved.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : DeploymentActivity

Type: object

A deployment activity record.

Show Source

• activity_id(required): string
  ID of the deployment activity.
• deployment_details(required): object DeploymentDetails
  Deployment configuration snapshot stored with an activity, recording the configuration the operation left behind. Every property is optional; a null value means the value is not available from any upstream system. Working out which values changed -- by comparing an activity against the one before it -- is left to the consumer.
• end_time(required): string
  Unix timestamp in milliseconds of when the activity ended.
• message: string
  Maximum Length: 2000

  Comment recorded with the activity.
• 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.
• status_message: string
  Maximum Length: 4000

  Details on the status, if it is not SUCCESS.
• user(required): string
  User that created the activity.

{
    "description":"A deployment activity record.",
    "type":"object",
    "required":[
        "activity_id",
        "operation_type",
        "status",
        "start_time",
        "end_time",
        "user",
        "deployment_details"
    ],
    "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"
        },
        "message":{
            "description":"Comment recorded with the activity.",
            "type":"string",
            "maxLength":2000
        },
        "status_message":{
            "description":"Details on the status, if it is not SUCCESS.",
            "type":"string",
            "maxLength":4000
        },
        "deployment_details":{
            "$ref":"#/definitions/DeploymentDetails"
        }
    }
}

Nested Schema : DeploymentDetails

Type: object

Deployment configuration snapshot stored with an activity, recording the configuration the operation left behind. Every property is optional; a null value means the value is not available from any upstream system. Working out which values changed -- by comparing an activity against the one before it -- is left to the consumer.

Show Source

• audience_claim: array audience_claim
  OAuth audience claims (aud). Set for OAUTH deployments; null otherwise.
• authorize_using: string
  Endpoint authorization mode: the deployment's authType (OAUTH or AIDP).
• autoscaling: boolean
  Whether the compute cluster autoscales.
• computeKey: string
  Compute key of the deployment.
• computeName: string
  Display name of the compute cluster the deployment targets.
• concurrency: integer(int32)
  Request concurrency. Not modelled by AI Compute today, so always null.
• cooldown: integer(int32)
  Autoscaling cooldown in minutes. Not modelled by AI Compute today, so always null.
• cpu_target: integer(int32)
  Autoscaling CPU target percentage. Not modelled by AI Compute today, so always null.
• deployment_targets: array deployment_targets
  Deployment targets of the deployment.
• description: string
  Description of the deployment.
• endpoint: string
  Serving endpoint of the deployment.
• instances: integer(int32)
  Number of replicas running. Not reported by AI Compute today, so always null.
• issuer_claim: string
  OAuth issuer claim (iss). Set for OAUTH deployments; null otherwise.
• jwks_uri: string
  URI to retrieve the JWKS. Set for OAUTH deployments; null otherwise.
• max_instances: integer(int32)
  Maximum number of compute replicas.
• memory_in_gbs: number(double)
  Memory in GB of the compute cluster shape.
• metric: string
  Autoscaling metric. Not modelled by AI Compute today, so always null.
• min_instances: integer(int32)
  Minimum number of compute replicas.
• model_name: string
  Name of the registered model.
• name: string
  Name of the deployment.
• ocpus: number(double)
  OCPUs of the compute cluster shape.
• status: string
  Allowed Values: [ "INACTIVE", "ACTIVATING", "ACTIVE", "DEACTIVATING", "UPDATING" ]

  Status of the deployment.
• tags: object tags
  Additional Properties Allowed: additionalProperties

  Tags of the deployment.
• workspaceKey: string
  Workspace key of the deployment.
• workspaceName: string
  Display name of the deployment's workspace.

{
    "description":"Deployment configuration snapshot stored with an activity, recording the configuration the operation left behind. Every property is optional; a null value means the value is not available from any upstream system. Working out which values changed -- by comparing an activity against the one before it -- is left to the consumer.",
    "type":"object",
    "properties":{
        "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"
        },
        "deployment_targets":{
            "description":"Deployment targets of the deployment.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DeploymentTarget"
            }
        },
        "status":{
            "description":"Status of the deployment.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentStatus",
            "enum":[
                "INACTIVE",
                "ACTIVATING",
                "ACTIVE",
                "DEACTIVATING",
                "UPDATING"
            ]
        },
        "endpoint":{
            "description":"Serving endpoint of the deployment.",
            "type":"string"
        },
        "tags":{
            "description":"Tags of the deployment.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "workspaceKey":{
            "description":"Workspace key of the deployment.",
            "type":"string"
        },
        "workspaceName":{
            "description":"Display name of the deployment's workspace.",
            "type":"string"
        },
        "computeKey":{
            "description":"Compute key of the deployment.",
            "type":"string"
        },
        "computeName":{
            "description":"Display name of the compute cluster the deployment targets.",
            "type":"string"
        },
        "ocpus":{
            "description":"OCPUs of the compute cluster shape.",
            "type":"number",
            "format":"double"
        },
        "memory_in_gbs":{
            "description":"Memory in GB of the compute cluster shape.",
            "type":"number",
            "format":"double"
        },
        "autoscaling":{
            "description":"Whether the compute cluster autoscales.",
            "type":"boolean"
        },
        "min_instances":{
            "description":"Minimum number of compute replicas.",
            "type":"integer",
            "format":"int32"
        },
        "max_instances":{
            "description":"Maximum number of compute replicas.",
            "type":"integer",
            "format":"int32"
        },
        "instances":{
            "description":"Number of replicas running. Not reported by AI Compute today, so always null.",
            "type":"integer",
            "format":"int32"
        },
        "concurrency":{
            "description":"Request concurrency. Not modelled by AI Compute today, so always null.",
            "type":"integer",
            "format":"int32"
        },
        "cpu_target":{
            "description":"Autoscaling CPU target percentage. Not modelled by AI Compute today, so always null.",
            "type":"integer",
            "format":"int32"
        },
        "cooldown":{
            "description":"Autoscaling cooldown in minutes. Not modelled by AI Compute today, so always null.",
            "type":"integer",
            "format":"int32"
        },
        "metric":{
            "description":"Autoscaling metric. Not modelled by AI Compute today, so always null.",
            "type":"string"
        },
        "authorize_using":{
            "description":"Endpoint authorization mode: the deployment's authType (OAUTH or AIDP).",
            "type":"string"
        },
        "audience_claim":{
            "description":"OAuth audience claims (aud). Set for OAUTH deployments; null otherwise.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "issuer_claim":{
            "description":"OAuth issuer claim (iss). Set for OAUTH deployments; null otherwise.",
            "type":"string"
        },
        "jwks_uri":{
            "description":"URI to retrieve the JWKS. Set for OAUTH deployments; null otherwise.",
            "type":"string"
        }
    }
}

Nested Schema : audience_claim

Type: array

OAuth audience claims (aud). Set for OAUTH deployments; null otherwise.

Show Source

• Array of: string

{
    "description":"OAuth audience claims (aud). Set for OAUTH deployments; null otherwise.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : deployment_targets

Type: array

Deployment targets of the deployment.

Show Source

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

{
    "description":"Deployment targets of the deployment.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DeploymentTarget"
    }
}

Nested Schema : tags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Tags of the deployment.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Tags of the deployment.

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

412 Response

Precondition Failed (One or more conditions in request failed).

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