Jump to

• Request
• Response

(Preview) Return the latest known deployment summary for a bundle

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles/actions/getDeploymentStatus

(Preview) Returns a high-level summary of the most recent deployment activity recorded for the specified bundle. This operation is useful after deploy or purge requests when you want the latest bundle-level deployment outcome rather than raw async operation details. The response can include: - overall deployment status - start and completion timestamps - summary message - resources associated with the last recorded deployment result Typical status values include: - `IN_PROGRESS` - `SUCCEEDED` - `FAILED` - `NOT_DEPLOYED` Request notes: - `path` identifies the bundle root folder in the workspace volume

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  The key of the Workspace

Header Parameters

• opc-request-id: string
  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 ()

Request payload for FetchBundleDeploymentStatusDetails.

Root Schema : FetchBundleDeploymentStatusDetails

Type: object

Request payload for fetch BundleDeploymentStatus.

Show Source

• path(required): string
  Target folder for the new bundle.

{
    "description":"Request payload for fetch BundleDeploymentStatus.",
    "type":"object",
    "required":[
        "path"
    ],
    "properties":{
        "path":{
            "description":"Target folder for the new bundle.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Last deployment summary for the bundle.

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 : BundleDeploymentStatus

Type: object

Summary of the most recent completed bundle deployment.

Show Source

• message: string
  Optional summary message for the last deployment.
• resources: array resources
  List of resources from the last deployment.
• status(required): string
  Allowed Values: [ "SUCCEEDED", "FAILED", "IN_PROGRESS", "NOT_DEPLOYED" ]

  Overall status of the last deployment.
• timeCompleted(required): string(date-time)
  The deployment end time
• timeStarted(required): string(date-time)
  The deployment start time

{
    "description":"Summary of the most recent completed bundle deployment.\n",
    "type":"object",
    "required":[
        "status",
        "timeStarted",
        "timeCompleted"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"Overall status of the last deployment.",
            "enum":[
                "SUCCEEDED",
                "FAILED",
                "IN_PROGRESS",
                "NOT_DEPLOYED"
            ]
        },
        "timeStarted":{
            "type":"string",
            "description":"The deployment start time",
            "format":"date-time"
        },
        "timeCompleted":{
            "type":"string",
            "description":"The deployment end time",
            "format":"date-time"
        },
        "message":{
            "type":"string",
            "description":"Optional summary message for the last deployment."
        },
        "resources":{
            "description":"List of resources from the last deployment.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/BundleDeployedResource"
            }
        }
    }
}

Nested Schema : resources

Type: array

List of resources from the last deployment.

Show Source

• Array of: object BundleDeployedResource
  Reference to a deployed resource.

{
    "description":"List of resources from the last deployment.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/BundleDeployedResource"
    }
}

Nested Schema : BundleDeployedResource

Type: object

Reference to a deployed resource.

Show Source

• key: string
  Workspace unique key for the resource
• name(required): string
  Resource name
• type(required): string
  Allowed Values: [ "JOB", "AGENTFLOW" ]

  Type of resource

{
    "description":"Reference to a deployed resource.",
    "type":"object",
    "required":[
        "type",
        "name"
    ],
    "properties":{
        "type":{
            "description":"Type of resource",
            "type":"string",
            "enum":[
                "JOB",
                "AGENTFLOW"
            ]
        },
        "key":{
            "description":"Workspace unique key for the resource",
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"Resource name"
        }
    }
}

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