Jump to

• Request
• Response

(Preview) Roll a model deployment back

post

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

(Preview) Rolls an active model deployment back to a lower model version of the same registered model.

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 ()

Details for the model deployment roll back.

Root Schema : RollBackModelDeploymentDetails

Type: object

The data to roll a model deployment back to a lower model version of the same registered model. Exactly one deployment target may be provided; its model_version must be lower than the version currently configured on the deployment.

Show Source

• deployment_id(required): string
  Minimum Length: 32

  Maximum Length: 32

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

  ID of the deployment to roll back.
• deployment_targets(required): array deployment_targets
  Minimum Number of Items: 1

  Maximum Number of Items: 1

  The single target model version to roll back to (exactly one, at 100% traffic).
• message: string
  Maximum Length: 2000

  Optional deployment roll-back message. At most 2000 characters and 2000 UTF-8 bytes.

{
    "description":"The data to roll a model deployment back to a lower model version of the same registered model. Exactly one deployment target may be provided; its model_version must be lower than the version currently configured on the deployment.",
    "type":"object",
    "required":[
        "deployment_id",
        "deployment_targets"
    ],
    "properties":{
        "deployment_id":{
            "description":"ID of the deployment to roll back.",
            "type":"string",
            "minLength":32,
            "maxLength":32,
            "pattern":"^[0-9a-f]{32}$"
        },
        "message":{
            "description":"Optional deployment roll-back message. At most 2000 characters and 2000 UTF-8 bytes.",
            "type":"string",
            "maxLength":2000
        },
        "deployment_targets":{
            "description":"The single target model version to roll back to (exactly one, at 100% traffic).",
            "type":"array",
            "minItems":1,
            "maxItems":1,
            "items":{
                "$ref":"#/definitions/DeploymentTarget"
            }
        }
    }
}

Nested Schema : deployment_targets

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1

The single target model version to roll back to (exactly one, at 100% traffic).

Show Source

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

{
    "description":"The single target model version to roll back to (exactly one, at 100% traffic).",
    "type":"array",
    "minItems":1,
    "maxItems":1,
    "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
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted. The model deployment roll-back is tracked as an asynchronous operation.

Headers

• aidp-async-operation-key: string
  The key of the asynchronous operations associated with an AI Data Platform instance. Use GetAsyncOperation with this key to track the status of the request.
• 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.

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

409 Response

Conflict. Request conflicts with the current state of the resource.

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