Overview
Install and manage Cloudera AI applications.
Version information
Version : 0.9.128
License information
License : Apache 2.0
Terms of service : https://www.cloudera.com/legal/commercial-terms-and-conditions.html
URI scheme
Schemes : HTTPS
Consumes
-
application/json
Produces
-
application/json
Paths
Add new Cloudera AI workbench cluster instance groups.
POST /api/v1/ml/addInstanceGroups
Description
Add new Cloudera AI workbench cluster instance groups.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Add instance group to an existing Cloudera AI Inference Service instance.
POST /api/v1/ml/addInstanceGroupsMlServingApp
Description
Add instance group to an existing Cloudera AI Inference Service instance.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Backup a Cloudera AI workbench.
POST /api/v1/ml/backupWorkspace
Description
Backup a Cloudera AI workbench.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deploys Cloudera AI Inference Service into an existing Kubernetes cluster.
POST /api/v1/ml/createMlServingApp
Description
Deploys Cloudera AI Inference Service into an existing Kubernetes cluster.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a new model registry.
POST /api/v1/ml/createModelRegistry
Description
Create a new model registry by creating a new workbench and install model registry on it.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Create a Cloudera AI workbench.
POST /api/v1/ml/createWorkspace
Description
Provision a Kubernetes cluster and install the Cloudera AI application in it.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deletes a backup snapshot.
POST /api/v1/ml/deleteBackup
Description
Deletes a Cloudera AI workbench backup.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deletes an instance group from the cluster.
POST /api/v1/ml/deleteInstanceGroup
Description
Deletes an instance group from a Cloudera AI workbench.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deletes an instance group from a Cloudera AI Inference Service instance.
POST /api/v1/ml/deleteInstanceGroupMlServingApp
Description
Deletes an instance group from a Cloudera AI Inference Service instance.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deletes Cloudera AI Inference Service instance.
POST /api/v1/ml/deleteMlServingApp
Description
Gracefully deletes the Cloudera AI Inference Service instance without deleting the cluster.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deletes a model registry.
POST /api/v1/ml/deleteModelRegistry
Description
Delete a model registry.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Delete Cloudera AI workbench.
POST /api/v1/ml/deleteWorkspace
Description
Deletes a Cloudera AI workbench.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe Cloudera AI Inference Service instance.
POST /api/v1/ml/describeMlServingApp
Description
Describe Cloudera AI Inference Service instance.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe Cloudera AI Model Registry.
POST /api/v1/ml/describeModelRegistry
Description
Describes a Cloudera AI Model Registry.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe Cloudera AI workbench.
POST /api/v1/ml/describeWorkspace
Description
Describes a Cloudera AI workbench.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Gets all the events belong to a workbench crn.
POST /api/v1/ml/getAuditEvents
Description
Gets all the events belong to a workbench crn.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
ListWorkspaceAccess Cloudera AI workbench.
POST /api/v1/ml/getKubeconfig
Description
Lists users that can perform Kubernetes operations on a Cloudera AI workbench via EKS.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
GetLatestWorkspaceVersion Cloudera AI workbench.
POST /api/v1/ml/getLatestWorkspaceVersion
Description
Retrieves the latest version that Cloudera AI deploys to workbenches.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Gets all the logs belong to a request id.
POST /api/v1/ml/getLogs
Description
Gets all the logs belong to a request id.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Return kubeconfig for a Cloudera AI Inference Service Kubernetes cluster.
POST /api/v1/ml/getMlServingAppKubeconfig
Description
Gets the Kubeconfig of the Cloudera AI Inference Service kubernetes cluster.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
GetModelRegistryKubeconfig returns kube config for model registry.
POST /api/v1/ml/getModelRegistryKubeconfig
Description
Gets the Kubeconfig of the model registry cluster.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Grants admin access to a Cloudera AI Inference Service cluster.
POST /api/v1/ml/grantMlServingAppAccess
Description
Grants an AWS user permissions to perform Kubernetes operations on a Cloudera AI Inference Service cluster.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
GrantModelRegistryAccess Cloudera AI Model Registry.
POST /api/v1/ml/grantModelRegistryAccess
Description
Grants an AWS user to perform Kubernetes operations on a Cloudera AI model registry via EKS.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
GrantWorkspaceAccess Cloudera AI workbench.
POST /api/v1/ml/grantWorkspaceAccess
Description
Grants an AWS user to perform Kubernetes operations on a Cloudera AI workbench via EKS.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List the instance configuration for a given instance type.
POST /api/v1/ml/listInstanceTypeConfiguration
Description
List of instances.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List members that have Kubernetes access to a Cloudera AI Inference Service cluster.
POST /api/v1/ml/listMlServingAppAccess
Description
Lists users that can perform Kubernetes operations on a Cloudera AI Inference Service cluster.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List all Cloudera AI Inference Service instances.
POST /api/v1/ml/listMlServingApps
Description
List all Cloudera AI Inference Service instances.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Lists all model registries.
POST /api/v1/ml/listModelRegistries
Description
List all model registries.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
ListWorkspaceAccess Cloudera AI Model Registry.
POST /api/v1/ml/listModelRegistryAccess
Description
Lists users that can perform Kubernetes operations on a Cloudera AI model registry via EKS.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List the instance types for Cloudera AI workbench creation that have the requested resource.
POST /api/v1/ml/listRelevantInstances
Description
List of relevant instance type for Cloudera AI workbench creation.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
ListWorkspaceAccess Cloudera AI workbench.
POST /api/v1/ml/listWorkspaceAccess
Description
Lists users that can perform Kubernetes operations on a Cloudera AI workbench via EKS.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List backup snapshots of a workbench.
POST /api/v1/ml/listWorkspaceBackups
Description
List backup snapshots of a workbench.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List Cloudera AI workbenches.
POST /api/v1/ml/listWorkspaces
Description
List Cloudera AI workbenches.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Modify Cloudera AI workbench cluster instance group.
POST /api/v1/ml/modifyClusterInstanceGroup
Description
Modify a Cloudera AI workbench cluster instance group.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Modify Cloudera AI workbench cluster security.
POST /api/v1/ml/modifyClusterSecurity
Description
Modify a Cloudera AI workbench cluster security.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Modify instance groups for a Cloudera AI Inference Service cluster.
POST /api/v1/ml/modifyMlServingApp
Description
Modify instance groups for a Cloudera AI Inference Service cluster.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Modify Cloudera AI workbench loadbalancer.
POST /api/v1/ml/modifyWorkspaceLoadBalancer
Description
Modify a Cloudera AI workbench loadbalancer.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Refreshes the model registry configmap of the workbench.
POST /api/v1/ml/refreshModelRegistryConfigmap
Description
Refreshes the model registry configmap of the workbench from the control plane.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Request a workflow cancellation.
POST /api/v1/ml/requestWorkflowCancellation
Description
Request a long running workflow cancellation by resource ID and workflow type.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Restore a Cloudera AI workbench.
POST /api/v1/ml/restoreWorkspace
Description
Create a new workbench based on an existing workbench backup snapshot.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Resume Cloudera AI workbench.
POST /api/v1/ml/resumeWorkspace
Description
Resume a Cloudera Machine Learnings workbench.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Revokes access to a Cloudera AI Inference Service cluster.
POST /api/v1/ml/revokeMlServingAppAccess
Description
Revokes an AWS user permissions on a Cloudera AI Inference Service cluster.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
RevokeModelRegistryAccess Cloudera AI Model Registry.
POST /api/v1/ml/revokeModelRegistryAccess
Description
Revokes an AWS user to perform Kubernetes operations on a Cloudera AI model registry via EKS.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
RevokeWorkspaceAccess Cloudera AI workbench.
POST /api/v1/ml/revokeWorkspaceAccess
Description
Revokes an AWS user to perform Kubernetes operations on a Cloudera AI workbench via EKS.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Rollback a model registry upgrade. Restore prior model registry.
POST /api/v1/ml/rollbackModelRegistryUpgrade
Description
Rollback a model registry upgrade. Restore prior model registry.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Suspend Cloudera AI workbench.
POST /api/v1/ml/suspendWorkspace
Description
Suspend a Cloudera AI workbench.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Upgrade a Cloudera AI Inference Service instance.
POST /api/v1/ml/upgradeMlServingApp
Description
Upgrade a Cloudera AI Inference Service instance to the latest available version.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Upgrade a model registry.
POST /api/v1/ml/upgradeModelRegistry
Description
Upgrade a model registry.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Upgrade Cloudera AI workbench.
POST /api/v1/ml/upgradeWorkspace
Description
Upgrades a Cloudera AI workbench to the latest available version.
Parameters
Type | Name | Schema |
---|---|---|
Body |
input |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Definitions
AddInstanceGroupsMlServingAppRequest
Request object for AddInstanceGroupsMlServingApp method.
Name | Description | Schema |
---|---|---|
appCrn |
The CRN of the Cloudera AI Inference Service instance to which the instance groups will be added. |
string |
instanceGroups |
The instance groups to be added to the Cloudera AI Inference Service instance. |
< InstanceGroup > array |
AddInstanceGroupsMlServingAppResponse
Response object for AddInstanceGroupsMlServingApp method.
Type : object
AddInstanceGroupsRequest
Request object for AddInstanceGroups.
Name | Description | Schema |
---|---|---|
instanceGroups |
The instance groups that we want to add to the workbench. |
< InstanceGroup > array |
workspaceCrn |
The CRN of the workbench to which the instance groups are to be added. |
string |
AddInstanceGroupsResponse
Response object for AddInstanceGroups.
Type : object
AuditEvent
Audit event descibes an performed or performing in a given workbench.
Name | Description | Schema |
---|---|---|
action |
Action the user has generated. |
string |
createdDate |
Time at creation of event. |
string (date-time) |
requestID |
Unique request ID to keep track of event. |
string |
userCrn |
UserCrn to track which user has caused the event. |
string |
workspaceCrn |
workbench crn where the event observed. |
string |
AuditEvents
AuditEvents contains all the audit events for a given workbench crn.
Name | Description | Schema |
---|---|---|
events |
AuditEvent belong to the workbench crn. |
< AuditEvent > array |
workspaceCrn |
workbench crn unique for the set of audit events. |
string |
AuditLog
Audit log represents an individual log.
Name | Description | Schema |
---|---|---|
createdDate |
Time at which the log is created. |
string (date-time) |
log |
Log description. |
string |
AuditLogs
AuditLogs contains all the logs for a given request id.
Name | Description | Schema |
---|---|---|
count |
Total number of logs associated with the request id. |
integer (int32) |
logs |
Contains all the logs for a given request id. |
< AuditLog > array |
requestID |
The request ID associated with a long-running operation to fetch the logs for. |
string |
Autoscaling
Configuration for instance auto scaling.
Name | Description | Schema |
---|---|---|
enabled |
The boolean flag to enable the auto scaling. |
boolean |
maxInstances |
The maximum number of instance for auto scaling. |
integer (int32) |
minInstances |
The minimum number of instance for auto scaling. |
integer (int32) |
BackupDetail
Backup Detail response object for listing backups.
Name | Description | Schema |
---|---|---|
backupCrn |
The CRN of the backup snapshot. |
string |
backupName |
The name of the backup snapshot. |
string |
backupStatus |
The status of the backup. |
string |
createdAt |
The creation time of the backup snapshot. |
string (date-time) |
creatorCrn |
The CRN of the creator. |
string |
workspaceVersionAtBackup |
The version of the backed-up workbench at the time of backup. |
string |
BackupMetadata
Backup metadata response object for the workbench summary.
Name | Description | Schema |
---|---|---|
backupVaultName |
The backup vault name. |
string |
isSuccessfulBackupAvailable |
Whether successful backups are available for the workbench. |
boolean |
lastBackupStatus |
The status of the last backup initiated. |
string |
lastSuccessfulBackupTime |
The time when the last successful backup was taken. |
string (date-time) |
numberOfAvailableBackups |
The number of backups available. |
integer (int64) |
BackupWorkspaceRequest
The request object for Cloudera AI workbench backup.
Name | Description | Schema |
---|---|---|
backupJobTimeoutMinutes |
The timeout(in minutes) to use for the execution of the backup jobs. |
integer (int32) |
backupName |
Backup name. |
string |
skipValidation |
Skip pre-flight validations if requested. |
boolean |
workspaceCrn |
CRN of the workbench to backup. |
string |
BackupWorkspaceResponse
The response object for Cloudera AI workbench backup.
Name | Description | Schema |
---|---|---|
backupCrn |
CRN of the backup generated. |
string |
vaultName |
Name of the vault where backup related volumes are stored. |
string |
CreateMlServingAppRequest
Request object for the CreateMlServingApp method.
Name | Description | Schema |
---|---|---|
appName |
The name of the Cloudera AI Inference Service to be created. |
string |
clusterCrn |
The cluster CRN of an existing cluster where Cloudera AI Inference Service instance will be deployed. |
string |
environmentCrn |
The environment CRN. |
string |
loadBalancerIPWhitelists |
The whitelist of IPs for load balancer. |
< string > array |
provisionK8sRequest |
The request for Kubernetes cluster provisioning. Required in public cloud. |
|
skipValidation |
Skip pre-flight validations if requested. |
boolean |
staticSubdomain |
The static subdomain to be used for the Cloudera AI Inference Service instance. |
string |
subnetsForLoadBalancers |
The list of subnets to be used for the load balancer. |
< string > array |
usePublicLoadBalancer |
The boolean flag to request a public load balancer. By default, a private load balancer is used. |
boolean |
CreateMlServingAppResponse
Response object for the CreateMlServingApp method.
Name | Description | Schema |
---|---|---|
appCrn |
The CRN of the Cloudera AI Inference Service created. |
string |
CreateModelRegistryRequest
Request object for creating model registry.
Name | Description | Schema |
---|---|---|
authorizedIPRanges |
The whitelist of CIDR blocks which can access the API server. |
< string > array |
backupCrn |
The CRN of the backup that this model registry is created from. |
string |
creatorCrn |
The creator of model registry. |
string |
environmentCrn |
The environment CRN of model registry. |
string |
environmentName |
The environment for the model registry to create. |
string |
namespace |
The namespace of the model registry. |
string |
outboundTypes |
Outbound Types provided for the cluster. |
< OutboundTypes > array |
privateCluster |
Whether to create a private cluster. |
boolean |
provisionK8sRequest |
The request for Kubernetes cluster provision. Required in public cloud. |
|
s3AccessKey |
The S3 access key of Ozone. |
string |
s3Bucket |
The s3Bucket of Ozone. |
string |
s3Endpoint |
The endpoint of Ozone. |
string |
s3SecretKey |
The S3 secret key of Ozone. |
string |
skipValidation |
Skip pre-flight validations if requested. |
boolean |
subnetsForLoadBalancers |
The list of subnets used for the load balancer that Cloudera AI creates. |
< string > array |
usePublicLoadBalancer |
The boolean flag to request a public load balancer. By default, a private load balancer is used. |
boolean |
whitelistAuthorizedIPRanges |
Whether to whitelist only authorizedIPRanges given or all public IPs |
boolean |
CreateModelRegistryResponse
Response for creating model registry request.
Type : object
CreateWorkspaceRequest
Request object for the CreateWorkspace method.
Name | Description | Schema |
---|---|---|
authorizedIPRanges |
The whitelist of CIDR blocks which can access the API server. |
< string > array |
cdswMigrationMode |
Toggle for cdsw migration preflight validation |
string |
disableTLS |
The boolean flag to disable TLS setup for workbench. By default, the TLS is enabled. |
boolean |
enableGovernance |
Enables Cloudera AI governance by integrating with Cloudera Atlas. By default, this flag is disabled. |
boolean |
enableModelMetrics |
Enables the model metrics service for exporting metrics for models to a metrics store. |
boolean |
enableMonitoring |
The boolean flag is used to enable monitoring. By default, monitoring is disabled. |
boolean |
environmentName |
The environment for the workbench to create. |
string |
existingDatabaseConfig |
Optional configurations for an existing Postgres to export model metrics to. |
|
existingNFS |
Optionally use an existing NFS by providing the hostname and desired path (Azure and Private Cloud only). |
string |
loadBalancerIPWhitelists |
The whitelist of IPs for load balancer. |
< string > array |
nfsVersion |
The NFS Protocol version of the NFS server we are using for Azure and Private Cloud. |
string |
outboundTypes |
Outbound Types provided for the workbench. |
< OutboundTypes > array |
privateCluster |
Whether to create a private cluster. |
boolean |
provisionK8sRequest |
The request for Kubernetes workbench provision. Required in public cloud. |
|
skipValidation |
Skip pre-flight validations if requested. |
boolean |
staticSubdomain |
The static subdomain to be used for the workbench. |
string |
subnetsForLoadBalancers |
The list of subnets used for the load balancer that Cloudera AI creates. |
< string > array |
usePublicLoadBalancer |
The boolean flag to request public load balancer. By default, private load balancer is used. |
boolean |
whitelistAuthorizedIPRanges |
Whether to whitelist only 'authorizedIPRanges' given or all public IPs. |
boolean |
workspaceName |
The name of the workbench to create. |
string |
CreateWorkspaceResponse
Response object for the CreateWorkspace method.
Type : object
DeleteBackupRequest
The request object for DeleteBackup operation.
Name | Description | Schema |
---|---|---|
backupCrn |
The CRN of the backup to be deleted. |
string |
skipValidation |
Skip pre-flight validations if requested. |
boolean |
DeleteBackupResponse
The response object for DeleteBackup operation.
Name | Description | Schema |
---|---|---|
workflowId |
The ID of the delete-backup workflow. |
string |
DeleteInstanceGroupMlServingAppRequest
Request object for the DeleteInstanceGroupMlServingApp method.
Name | Description | Schema |
---|---|---|
appCrn |
The CRN of the Cloudera AI Inference Service from which instance group is to be deleted. |
string |
instanceGroupName |
The instance group to be deleted from the Cloudera AI Inference Service instance. |
string |
DeleteInstanceGroupMlServingAppResponse
Response object for the DeleteInstanceGroupMlServingApp method.
Type : object
DeleteInstanceGroupRequest
Request object for the DeleteInstanceGroup method.
Name | Description | Schema |
---|---|---|
instanceGroupName |
The instance group that we want to delete from the workbench. |
string |
workspaceCrn |
The CRN of the workbench from which instance group is to be deleted. |
string |
DeleteInstanceGroupResponse
Response object for the DeleteInstanceGroup method.
Type : object
DeleteMlServingAppRequest
Request object for the DeleteMlServingApp method.
Name | Description | Schema |
---|---|---|
appCrn |
The CRN of the Cloudera AI Inference Service to be deleted. |
string |
DeleteMlServingAppResponse
Response object for the DeleteMlServingApp method.
Type : object
DeleteModelRegistryRequest
Request for deleting model registry.
Name | Description | Schema |
---|---|---|
force |
Force delete a model registry workbench even if errors occur during deletion. Force delete removes the guarantee that resources in your cloud account will be cleaned up. By default, force is set to false. |
boolean |
id |
Deprecated, please use modelRegistryCrn. The environment CRN of the model registry. |
string |
modelRegistryCrn |
CRN of the model registry to be deleted. |
string |
workspaceCrn |
Deprecated. The workbench CRN of the model registry (Public cloud only). |
string |
DeleteModelRegistryResponse
Delete model registry response.
Type : object
DeleteWorkspaceRequest
Request object for the DeleteWorkspace method.
Name | Description | Schema |
---|---|---|
environmentName |
The environment for the workbench to delete. |
string |
force |
Force delete a workbench even if errors occur during deletion. Force delete removes the guarantee that resources in your cloud account will be cleaned up. |
boolean |
removeStorage |
The remove storage flag indicates weather to keep the backing workbench filesystem storage or remove it during delete. |
boolean |
workspaceCrn |
The CRN of the workbench to delete. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored. |
string |
workspaceName |
The name of the workbench to delete. |
string |
DeleteWorkspaceResponse
Response object for the DeleteWorkspace method.
Type : object
DescribeMlServingAppRequest
Request object for the DescribeMlServingApp method.
Name | Description | Schema |
---|---|---|
appCrn |
The CRN of the Cloudera AI Inference Service. |
string |
DescribeMlServingAppResponse
Response object for the DescribeMlServingApp method.
Name | Description | Schema |
---|---|---|
app |
The Cloudera AI Inference Service instance. |
DescribeModelRegistryRequest
Request object for the DescribeModelRegistry method.
Name | Description | Schema |
---|---|---|
modelRegistryCrn |
The CRN of the Model Registry to describe. |
string |
DescribeModelRegistryResponse
Response object for the DescribeModelRegistry method.
Name | Description | Schema |
---|---|---|
modelRegistry |
The registry. |
DescribeWorkspaceRequest
Request object for the DescribeWorkspace method.
Name | Description | Schema |
---|---|---|
environmentName |
The environment for the workbench to describe. |
string |
workspaceCrn |
The CRN of the workbench to describe. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored. |
string |
workspaceName |
The name of the workbench to describe. |
string |
DescribeWorkspaceResponse
Response object for the DescribeWorkspace method.
Name | Description | Schema |
---|---|---|
workspace |
The workbench. |
Error
An object returned on an error.
Name | Description | Schema |
---|---|---|
code |
The error code. |
string |
message |
The error message. |
string |
ExistingDatabaseConfig
Configurations for bringing an existing database for model metrics
Name | Description | Schema |
---|---|---|
existingDatabaseHost |
Optionally provide a Postgresql database host to export model metrics to. |
string |
existingDatabaseName |
Optionally provide a Postgresql database name to export model metrics to. |
string |
existingDatabasePassword |
Optionally provide a Postgresql database password to use when exporting model metrics. |
string |
existingDatabasePort |
Optionally provide a Postgresql database port to export model metrics to. |
string |
existingDatabaseUser |
Optionally provide a Postgresql database user to use when exporting model metrics. |
string |
GetAuditEventsRequest
GetAuditEventsRequest to get all audit events for a given workbench crn.
Name | Description | Schema |
---|---|---|
resourceCrn |
Resource crn for which audit events to be fetched. Resource can be workbench or model registry. |
string |
workspaceCrn |
Deprecated, please begin to use Resource crn, as this will soon be unsupported. |
string |
GetAuditEventsResponse
GetAuditEventsResponse containes all the audit events for a given workbench crn.
Name | Description | Schema |
---|---|---|
auditEvents |
Contains all the audit events for a given workbench crn. |
GetKubeconfigRequest
Request object for the GetKubeconfig method.
Name | Description | Schema |
---|---|---|
environmentName |
The environment that the workbench is a member of. |
string |
workspaceCrn |
The CRN of the workbench to list access. |
string |
workspaceName |
The name of the workbench to list access. |
string |
GetKubeconfigResponse
Response object for the GetKubeconfig method.
Name | Description | Schema |
---|---|---|
kubeconfig |
The list of users that have access. |
string |
GetLatestWorkspaceVersionRequest
Request object for GetLatestWorkspaceVersion.
Type : object
GetLatestWorkspaceVersionResponse
Response object for GetLatestWorkspaceVersion.
Name | Description | Schema |
---|---|---|
version |
The latest version of a workbench that is used when deploying Cloudera AI workbenches. |
string |
GetLogsRequest
GetLogsRequest for getting logs for a request ID.
Name | Description | Schema |
---|---|---|
fetchAll |
Flag to fetch all logs. |
boolean |
offset |
offset from which the logs should be fetched. |
integer (int32) |
pageSize |
Limit the number of logs. |
integer (int32) |
requestID |
Unique Key to identify a set of logs. |
string |
workspaceCrn |
Deprecated. Please begin to use resourceCrn, as this will soon be unsupported |
string |
GetLogsResponse
GetLogsResponse contains all the logs for a given request id.
Name | Description | Schema |
---|---|---|
auditLogs |
Contains all the logs for a given request id. |
GetMlServingAppKubeconfigRequest
Request object for the GetMlServingAppKubeconfig method.
Name | Description | Schema |
---|---|---|
appCrn |
The CRN of the Cloudera AI Inference Service instance for retrieving the kubeconfig. |
string |
GetMlServingAppKubeconfigResponse
Response object for the GetMlServingAppKubeconfig method.
Name | Description | Schema |
---|---|---|
kubeconfig |
The kubeconfig of the Cloudera AI Inference Kubernetes cluster. |
string |
GetModelRegistryKubeconfigRequest
Request object for GetModelRegistryKubeconfig.
Name | Description | Schema |
---|---|---|
modelRegistryCrn |
CRN of the Model Registry |
string |
GetModelRegistryKubeconfigResponse
GetModelRegistryKubeconfigResponse response provides model registry kube config.
Name | Description | Schema |
---|---|---|
kubeConfig |
KubeConfig of the model registry cluster |
string |
GrantMlServingAppAccessRequest
Request object for the GrantMlServingAppAccess method.
Name | Description | Schema |
---|---|---|
identifier |
The cloud provider user id, such as ARN, which will be granted access to the Cloudera AI Inference Service Kubernetes cluster. |
string |
resourceCrn |
The CRN of the Cloudera AI Inference Service instance to which access is to be granted. |
string |
GrantMlServingAppAccessResponse
Response object for the GrantMlServingAppAccess method.
Name | Description | Schema |
---|---|---|
kubeconfig |
The Kubernetes config file |
string |
GrantModelRegistryAccessRequest
Request object for the GrantModelRegistryAccess method.
Name | Description | Schema |
---|---|---|
identifier |
The cloud provider user id, such as ARN, which will be granted access to the model registry’s Kubernetes cluster. |
string |
resourceCrn |
The CRN of the Model Registry to grant access to. |
string |
GrantModelRegistryAccessResponse
Response object for the GrantModelRegistryAccess method.
Name | Description | Schema |
---|---|---|
kubeconfig |
The Kubernetes config file |
string |
GrantWorkspaceAccessRequest
Request object for the GrantWorkspaceAccess method.
Name | Description | Schema |
---|---|---|
arn |
The aws user ARN to grant access to the corresponding EKS cluster. (Deprecated: Use identifier instead). |
string |
environmentName |
The environment that the workbench is a member of. |
string |
identifier |
The cloud provider user id which will be granted access to the workbench’s Kubernetes cluster. |
string |
workspaceCrn |
The CRN of the workbench to grant access to. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored. |
string |
workspaceName |
The name of the workbench to grant access to. |
string |
GrantWorkspaceAccessResponse
Response object for the GrantWorkspaceAccess method.
Name | Description | Schema |
---|---|---|
kubeconfig |
The Kubernetes config file |
string |
HealthInfo
Healthinfo object contains the health information of a resource.
Name | Description | Schema |
---|---|---|
details |
The detail of the health info. |
< string > array |
isHealthy |
The boolean that indicates the health status. |
boolean |
message |
The message to show for the health info. |
string |
resourceName |
The resource name being checked. |
string |
updatedAt |
The timestamp for the heartbeat. |
string (date-time) |
Instance
Represents each instance in an instance group.
Name | Description | Schema |
---|---|---|
availabilityZone |
Availability zone the instance belongs to. |
string |
instanceId |
Unique instance Id generated by the cloud provider. |
string |
InstanceDetails
Instance Details
Name | Description | Schema |
---|---|---|
category |
Name of the CPU/GPU category to which it belongs. |
string |
computeCapability |
Compute capability of the GPU. |
string |
cpu |
The number of CPU cores available for the instance in the region. |
string |
gpu |
The number of GPUs available for the instance in the region. |
string |
gpuMemory |
Memory capacity of the GPU. |
string |
gpuModel |
GPU model. |
string |
gpuType |
GPU model type. |
string |
interconnectType |
Type of interconnect between GPUs. |
string |
memory |
The amount of memory (RAM) available for the instance in the region, typically measured in GB. |
string |
name |
A unique name or identifier for the instance type in the region. |
string |
InstanceGroup
Contains the necessary info for an instance group.
Name | Description | Schema |
---|---|---|
autoscaling |
The auto scaling configuration. |
|
ingressRules |
The networking rules for the ingress. |
< string > array |
instanceCount |
The initial number of instance node. |
integer (int32) |
instanceTier |
The tier of the instance i.e. on-demand/spot. |
string |
instanceType |
The cloud provider instance type for the node instance. |
string |
name |
The unique name of the instance group. |
string |
rootVolume |
The root volume of the instance. |
KubernetesCluster
The Kubernetes cluster information
Name | Description | Schema |
---|---|---|
authorizedIpRanges |
The allow list of CIDR blocks which can access the API server. |
string |
authorizedIpRangesAllowList |
Whether to allow only 'authorizedIPRanges' given or all public IPs. |
boolean |
baseDomain |
The base domain for this cluster. |
string |
clusterCrn |
The cluster CRN of the kubernetes cluster. |
string |
clusterName |
The name of the Kubernetes cluster. |
string |
domainName |
The domain name for the cluster. |
string |
instanceGroups |
The instance groups. |
< WorkspaceInstanceGroup > array |
ipAllowlist |
The allow list of IPs for incoming connections. |
string |
isPublic |
Indicates if this cluster is accepting incoming connection from public internet. |
boolean |
liftieID |
The identifier in Cloudera Data Platform Compute Service corresponding to this Kubernetes cluster. |
string |
subnets |
The subnets associated with this cluster. |
string |
tags |
Tags provided by the user at the time of app creation. |
< Tag > array |
ListInstanceTypeConfigurationRequest
Request object for the ListInstanceTypeConfiguration method.
Name | Description | Schema |
---|---|---|
cloudProvider |
Identifies the cloud provider (e.g., AWS, Azure) for which to list supported instances. |
string |
instanceCategory |
Defines the category of the instance (e.g., CPU, GPU) relevant for the query in the specified region. |
string |
instanceType |
Identifies the instance type. |
string |
region |
Specifies the name of the region for which instance support details are requested. |
string |
ListInstanceTypeConfigurationResponse
Response object for the ListInstanceTypeConfiguration method.
Name | Description | Schema |
---|---|---|
instanceDetails |
Contains a list of instance details, including CPU, GPU, memory, and name, for queried supported instance type in the queried region. |
< InstanceDetails > array |
ListMlServingAppAccessRequest
Request object for the ListMlServingAppAccess method.
Name | Description | Schema |
---|---|---|
resourceCrn |
The CRN of the Cloudera AI Inference Service to list access. |
string |
ListMlServingAppAccessResponse
Response object for the ListMlServingAppAccess method.
Name | Description | Schema |
---|---|---|
users |
The list of users that have access. |
< string > array |
ListMlServingAppsRequest
Request object for the ListMlServingApps method.
Name | Description | Schema |
---|---|---|
queryOptions |
Additional query options. |
< string > array |
ListMlServingAppsResponse
Response object for the ListMlServingApps method.
Name | Description | Schema |
---|---|---|
apps |
The list of Apps. |
< MlServingApp > array |
ListModelRegistriesRequest
Request object for deleting model registry.
Type : object
ListModelRegistriesResponse
List of all available model registries.
Name | Description | Schema |
---|---|---|
modelRegistries |
The list of model registry. |
< ModelRegistry > array |
ListModelRegistryAccessRequest
Request object for the ListModelRegistryAccess method.
Name | Description | Schema |
---|---|---|
resourceCrn |
The CRN of the Model Registry to list access. |
string |
ListModelRegistryAccessResponse
Response object for the ListModelRegistryAccess method.
Name | Description | Schema |
---|---|---|
users |
The list of users that have access. |
< string > array |
ListRelevantInstancesRequest
Request object for the ListRelevantInstances method.
Name | Description | Schema |
---|---|---|
cloudProvider |
Identifies the cloud provider (e.g., AWS, Azure) for which to list supported instances. |
string |
instanceCategory |
Defines the category of the instance (e.g., CPU, GPU) relevant for the query in the specified region. |
string |
region |
Specifies the name of the region for which instance support details are requested. |
string |
requestInfo |
Specifies the requested resource inputs eg (CPU/GPU, model, memory etc). |
ListRelevantInstancesResponse
Response object for the ListRelevantInstances method.
Name | Description | Schema |
---|---|---|
instanceDetails |
Contains a list of instance details, including CPU, GPU, memory, and name, for supported instances in the queried region. |
< InstanceDetails > array |
ListWorkspaceAccessRequest
Request object for the ListWorkspace method.
Name | Description | Schema |
---|---|---|
environmentName |
The environment that the workbench is a member of. |
string |
workspaceCrn |
The CRN of the workbench to list access. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored. |
string |
workspaceName |
The name of the workbench to list access. |
string |
ListWorkspaceAccessResponse
Response object for the ListWorkspaceAccess method.
Name | Description | Schema |
---|---|---|
users |
The list of users that have access. |
< string > array |
ListWorkspaceBackupsQueryOptions
Query options object for ListWorkspaceBackups method.
Name | Description | Schema |
---|---|---|
expandEnvironmentMetadata |
When set to true, will return the metadata of the environment where the backed-up workbench is/was present. |
boolean |
ListWorkspaceBackupsRequest
Request object for ListWorkspaceBackups method.
Name | Description | Schema |
---|---|---|
environmentName |
The environment for the workbench to list backups for. |
string |
queryOptions |
Additional query options to enhance/mutate the API response. |
|
workspaceCrn |
The CRN of the workbench to list backups for. If this field is specified, environmentName and workspaceName are ignored. |
string |
workspaceName |
The name of the workbench to list backups for. |
string |
ListWorkspaceBackupsResponse
Response object for ListWorkspaceBackups method.
Name | Description | Schema |
---|---|---|
backups |
The list of backups along with their details. |
< BackupDetail > array |
ListWorkspacesRequest
Request object for the ListWorkspaces method.
Name | Description | Schema |
---|---|---|
queryOptions |
Additional query options. |
< string > array |
ListWorkspacesResponse
Response object for the ListWorkspaces method.
Name | Description | Schema |
---|---|---|
workspaces |
The list of workbenches. |
< WorkspaceSummary > array |
MlServingApp
The Cloudera AI Inference Service instance.
Name | Description | Schema |
---|---|---|
appCrn |
The CRN of the Cloudera AI Inference Service instance. |
string |
appName |
The name of the Cloudera AI Inference Service instance. |
string |
cloudPlatform |
The cloud platform of the environment that was used to create this instance. |
string |
cluster |
The Kubernetes cluster information. |
|
creationDate |
Creation date of Cloudera AI Inference Service instance. |
string (date-time) |
environmentCrn |
The CRN of the environment. |
string |
environmentName |
The name of the environment. |
string |
httpsEnabled |
Indicates if HTTPs communication was enabled on this application when it was provisioned. |
boolean |
isPrivateCluster |
Is this service installed on a private cluster. |
boolean |
mlServingVersion |
The Cloudera AI Inference Service version running on this instance. |
string |
namespace |
The namespace used for this service. |
string |
ownerEmail |
The email of the user who created this service. |
string |
status |
The status of the Cloudera AI Inference Service instance. |
string |
subnetsForLoadBalancers |
The list of subnets used for the load balancer. |
< string > array |
usePublicLoadBalancer |
Indicates if this Cloudera AI Inference Service instance uses a public load balancer. |
boolean |
MlServingProvisionK8sRequest
Request object for provisioning Cloudera AI Inference Service instance groups.
Name | Description | Schema |
---|---|---|
environmentCrn |
The CRN of the environment for the cluster to create. |
string |
instanceGroups |
The instance groups. |
< InstanceGroup > array |
network |
The overlay network for an AWS Kubernetes cluster’s CNI. |
|
tags |
Tags to add to the cloud provider resources created. This is in addition to any tags added by Cloudera. |
< ProvisionTag > array |
ModelRegistry
Model registry object
Name | Description | Schema |
---|---|---|
createdAt |
The creation time of model registry. |
string (date-time) |
creator |
The creator of model registry. |
string |
crn |
ModelRegistry CRN. |
string |
domain |
The domain of the model registry |
string |
endpointPublicAccess |
To indicate if the model registry standalone API endpoint is publicly accessible or not. |
boolean |
environmentCrn |
The environment CRN of model registry. |
string |
environmentName |
Environment name. |
string |
id |
The id of model registry. |
integer (int64) |
machineUserCrn |
The machine user CRN of the model registry. |
string |
namespace |
The namespace of model registry. |
string |
s3Bucket |
The s3 bucket of model registry. |
string |
s3Endpoint |
The Ozone endpoint of model registry. |
string |
serviceName |
The service name of model registry. |
string |
status |
The status of model registry. |
string |
version |
The version of the model registry. |
string |
workspaceCrn |
Deprecated. workbench CRN. This field is no longer used. |
string |
workspaceName |
Deprecated, please refer to serviceName. workbench name. |
string |
ModelRegistryProvisionK8sRequest
Request object for provisioning model registry.
Name | Description | Schema |
---|---|---|
network |
The overlay network for an AWS Kubernetes cluster’s CNI. |
|
tags |
Tags to add to the cloud provider resources created. This is in addition to any tags added by Cloudera. |
< ProvisionTag > array |
ModifyClusterInstanceGroupRequest
Request object for ModifyClusterInstanceGroup.
Name | Description | Schema |
---|---|---|
instanceGroupName |
The name of the instance group of the workbench cluster to modify. |
string |
instanceType |
The desired instance type of the workbench cluster instance group. |
string |
max |
The desired autoscaling min of the workbench cluster instance group. |
integer (int32) |
min |
The desired autoscaling min of the workbench cluster instance group. |
integer (int32) |
workspaceCrn |
The CRN of the workbench cluster to modify. |
string |
ModifyClusterInstanceGroupResponse
Response object for ModifyClusterInstanceGroup.
Type : object
ModifyClusterSecurityRequest
Request object for ModifyClusterSecurity.
Name | Description | Schema |
---|---|---|
allowlistAuthorizedIPRanges |
Whether to allow only authorized IP ranges given or all public IPs. |
boolean |
authorizedIPRanges |
The allowlist of CIDR blocks which can access the API server. |
< string > array |
workspaceCrn |
The CRN of the workbench cluster to modify. |
string |
ModifyClusterSecurityResponse
Response object for ModifyClusterSecurity.
Type : object
ModifyMlServingAppRequest
Request object for the ModifyMlServingApp method.
Name | Description | Schema |
---|---|---|
appCrn |
The CRN of the Cloudera AI Inference Service to be modified. |
string |
instanceGroupName |
The name of the instance group to be modified. |
string |
instanceType |
The desired instance type of the instance group. |
string |
max |
The desired maximum number of instances in the instance group. |
integer (int32) |
min |
The desired minimum number of instances in the instance group. |
integer (int32) |
ModifyMlServingAppResponse
Response object for ModifyMlServingApp method.
Type : object
ModifyWorkspaceLoadBalancerRequest
Request object for ModifyWorkspaceLoadBalancer.
Name | Description | Schema |
---|---|---|
loadBalancerIPAllowLists |
The allowlist of CIDR blocks which can access the loadbalancer. |
< string > array |
workspaceCrn |
The CRN of the workbench cluster to modify. |
string |
ModifyWorkspaceLoadBalancerResponse
Response object for ModifyWorkspaceLoadBalancer.
Type : object
OutboundTypes
List of possible Outbound types.
Type : enum (UNKNOWN, OUTBOUND_TYPE_UDR)
OverlayNetwork
Contains the information about overlay network.
Name | Description | Schema |
---|---|---|
plugin |
The plugin specifies specific cni vendor, ex: calico, weave etc. |
string |
topology |
The options for overlay topology. |
ProvisionK8sRequest
Request object for workbench provision. Required in public cloud.
Name | Description | Schema |
---|---|---|
environmentName |
The name of the environment for the workbench to create. |
string |
instanceGroups |
The instance groups. |
< InstanceGroup > array |
network |
The overlay network for an AWS Kubernetes cluster’s CNI. |
|
tags |
Tags to add to the cloud provider resources created. This is in addition to any tags added by Cloudera. |
< ProvisionTag > array |
ProvisionTag
Contains a single tag entry that will be configured on cloud resources associated with a workbench.
Name | Description | Schema |
---|---|---|
key |
The name for the tag. |
string |
value |
The value for the tag. |
string |
RefreshModelRegistryConfigmapRequest
Request for refreshing workbench’s model registry configmap.
Name | Description | Schema |
---|---|---|
workspaceCrn |
workbench CRN. |
string |
RefreshModelRegistryConfigmapResponse
Response for refreshing workbench’s model registry configmap.
Type : object
RequestResourceInfo
Instance Details
Name | Description | Schema |
---|---|---|
computeCapability |
The compute capability of the GPU. |
string |
cpu |
The number of CPU cores. |
string |
gpu |
The number of GPUs. |
string |
gpuMemory |
The GPU memory size of the resource. |
string |
gpuModel |
The model of the GPU, entails the complete name by the provider. |
string |
gpuType |
The gpu type, eg A100 |
string |
interconnectType |
The interconnect type between 2 resources. |
string |
memory |
The memory size of the resource. |
string |
RequestWorkflowCancellationRequest
Request object for RequestWorkflowCancellation.
Name | Description | Schema |
---|---|---|
resourceId |
The unique identifier of the resource. |
string |
workflowType |
The workflow type. |
string |
RequestWorkflowCancellationResponse
Response object for RequestWorkflowCancellation.
Name | Description | Schema |
---|---|---|
workflowMetadata |
The list of workflow metedata for cancelled workflows. |
< WorkflowMetadata > array |
RestoreWorkspaceRequest
Request object for RestoreWorkspace method.
Name | Description | Schema |
---|---|---|
backupCrn |
The CRN of the backup snapshot to used for restoring. |
string |
newWorkspaceParameters |
The parameters required for a new Cloudera AI workbench. |
|
restoreJobTimeoutMinutes |
The timeout to restore the backup snapshots, in minutes. |
integer (int32) |
useStaticSubdomain |
A boolean value to check if subdomain must be used or not. |
boolean |
RestoreWorkspaceResponse
Response object for the RestoreWorkspace method.
Name | Description | Schema |
---|---|---|
workspaceCrn |
The CRN of the Cloudera AI workbench being provisioned. |
string |
ResumeWorkspaceRequest
Request object for ResumeWorkspace.
Name | Description | Schema |
---|---|---|
workspaceCrn |
The CRN of the workbench to resume. |
string |
ResumeWorkspaceResponse
Response object for ResumeWorkspace.
Type : object
RevokeMlServingAppAccessRequest
Request object for the RevokeMlServingAppAccess method.
Name | Description | Schema |
---|---|---|
identifier |
The cloud provider user ID, such as ARN, from which access to the Cloudera AI Inference Service Kubernetes cluster needs to be revoked. |
string |
resourceCrn |
The CRN of the Cloudera AI Inference Service instance to revoke access. |
string |
RevokeMlServingAppAccessResponse
Response object for the RevokeMlServingAppAccess method.
Type : object
RevokeModelRegistryAccessRequest
Request object for the RevokeModelRegistry method.
Name | Description | Schema |
---|---|---|
identifier |
The cloud provider user id, such as ARN, which will be granted access to the model registry’s Kubernetes cluster. |
string |
resourceCrn |
The CRN of the Model Registry to grant access to. |
string |
RevokeModelRegistryAccessResponse
Response object for the RevokeModelRegistryAccess method.
Type : object
RevokeWorkspaceAccessRequest
Request object for the RevokeWorkspace method.
Name | Description | Schema |
---|---|---|
arn |
The aws user ARN to revoke access to the corresponding EKS cluster. (Deprecated: Use identifier instead). |
string |
environmentName |
The environment that the workbench is a member of. |
string |
identifier |
The cloud provider user id which will be granted access to the workbench’s Kubernetes cluster. |
string |
workspaceCrn |
The CRN of the workbench to revoke access to. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored. |
string |
workspaceName |
The name of the workbench to revoke access to. |
string |
RevokeWorkspaceAccessResponse
Response object for the RevokeWorkspaceAccess method.
Type : object
RollbackModelRegistryUpgradeRequest
Request for rollback model registry upgrade.
Name | Description | Schema |
---|---|---|
crn |
The CRN of the model registry. |
string |
RollbackModelRegistryUpgradeResponse
Response for rollback model registry request.
Type : object
RootVolume
Configuration for instance root device volume.
Name | Description | Schema |
---|---|---|
size |
The volume size in GB. |
integer (int64) |
SuspendWorkspaceRequest
Request object for SuspendWorkspace.
Name | Description | Schema |
---|---|---|
workspaceCrn |
The CRN of the workbench to suspend. |
string |
SuspendWorkspaceResponse
Response object for SuspendWorkspace.
Type : object
Tag
Contains a single tag entry associated with a workbench.
Name | Description | Schema |
---|---|---|
key |
The name for the tag. |
string |
value |
The value for the tag. |
string |
Topology
Contains the information about topology.
Name | Description | Schema |
---|---|---|
subnets |
The options for subnets. |
< string > array |
UpgradeMlServingAppRequest
Request object for the UpgradeMlServingApp method.
Name | Description | Schema |
---|---|---|
appCrn |
The Cloudera AI Inference Service CRN. |
string |
UpgradeMlServingAppResponse
Response object for the UpgradeMlServingApp method.
Type : object
UpgradeModelRegistryRequest
Request for upgrading model registry.
Name | Description | Schema |
---|---|---|
crn |
The CRN of the model registry to be upgraded. |
string |
UpgradeModelRegistryResponse
Response for upgrading model registry.
Name | Description | Schema |
---|---|---|
crn |
The CRN of the model registry after upgrade. |
string |
UpgradeState
Response object for the workbench summary.
Name | Description | Schema |
---|---|---|
reason |
The reason for the current state. |
string |
state |
The current upgrade state of the workbench. |
string |
UpgradeWorkspaceRequest
Request object for the UpgradeWorkspace method.
Name | Description | Schema |
---|---|---|
environmentName |
The environment of the workbench. |
string |
mlVersion |
The version of workbench to upgrade to. |
string |
workspaceCrn |
The CRN of the workbench. If CRN is specified only the CRN is used for identifying the workbench, environment and name arguments are ignored. |
string |
workspaceName |
The name of the workbench. |
string |
UpgradeWorkspaceResponse
Response object for the UpgradeWorkspace method.
Type : object
WorkflowMetadata
The workflow metadata.
Name | Description | Schema |
---|---|---|
lastKnownStatus |
The last known status of the workflow. |
string |
resourceId |
The unique identifier of the resource. |
string |
workflowId |
The workflow identifier. |
string |
workflowIndex |
The workflow index. Monotonically increases for each subsequent workflow for a resource. |
integer (int64) |
workflowType |
The workflow type. |
string |
Workspace
A ML workbench, which includes the cluster and storage.
Name | Description | Schema |
---|---|---|
authorizedIPRanges |
The whitelist of CIDR blocks which can access the API server. |
< string > array |
backupMetadata |
The Backup MetaData for this workbench |
|
cloudPlatform |
The cloud platform of the environment that was used to create this workbench. |
string |
clusterBaseDomain |
The basedomain of the cluster. |
string |
clusterID |
The Cluster ID for the workbench. |
string |
creationDate |
Creation date of workbench. |
string (date-time) |
creatorCrn |
The CRN of the creator of the workbench. |
string |
crn |
The CRN of the workbench. |
string |
endpointPublicAccess |
To check if the cluster is publicly accessible or not. |
boolean |
environmentCrn |
CRN of the environment. |
string |
environmentName |
The name of the workbench’s environment. |
string |
failureMessage |
Failure message from the most recent failure that has occurred during workbench provisioning. |
string |
filesystemID |
filesystemID used by the workbench |
string |
governanceEnabled |
Whether governance is enabled. |
boolean |
healthInfoLists |
The health info information of the workbench. |
< HealthInfo > array |
httpsEnabled |
To Display if Https is enabled or not. |
boolean |
instanceGroups |
The instance groups. |
< WorkspaceInstanceGroup > array |
instanceName |
The name of the workbench. |
string |
instanceStatus |
The workbench’s current status. |
string |
instanceUrl |
URL of the workbench’s user interface. |
string |
isPrivate |
The value to indicate if the cluster is private or not. |
boolean |
isRestored |
The value to indicate if the workbench is restored one or not |
boolean |
k8sClusterName |
The Kubernetes cluster name. |
string |
loadBalancerIPWhitelists |
IP whitelist for loadBalancer. |
< string > array |
modelMetricsEnabled |
Whether model metrics is enabled. |
boolean |
monitoringEnabled |
If usage monitoring is enabled or not on this workbench. |
boolean |
nfsVersion |
NFS Version of the filesystem. |
string |
subnets |
The subnets of the workbench. |
< string > array |
subnetsForLoadBalancers |
The list of subnets used for the load balancer that Cloudera AI creates. |
< string > array |
tags |
Tags provided by the user at the time of workbench creation. |
< Tag > array |
upgradeState |
The upgrade state contains the workbench upgrade information. |
|
version |
The version of Cloudera AI that was installed on the workbench. |
string |
whitelistAuthorizedIPRanges |
Whether to whitelist only 'authorizedIPRanges' given or all public IPs. |
boolean |
WorkspaceInstanceGroup
Instance group information to show in workbench details.
Name | Description | Schema |
---|---|---|
cpu |
Number of CPUs attached to this instance type. |
string |
gpu |
Number of GPUs attached to this instance type. |
string |
instanceCount |
The initial number of instance node. |
integer (int32) |
instanceGroupName |
The unique name of the instance group. |
string |
instanceType |
The cloud provider instance type for the node instance. |
string |
instances |
Instances in the instance group. |
< Instance > array |
maxInstances |
The maximum number of instances that can be deployed to this instance group. |
integer (int32) |
memory |
Memory in GiB attached to this instance type. |
string |
minInstances |
The minimum number of instances that can be deployed to this instance group. If the value is 0, the group might be empty. |
integer (int32) |
tags |
Tags are key/value pairs that are applied to all tag-able resources deployed in the workbench’s cloud environment. |
< Tag > array |
WorkspaceSummary
A Cloudera AI workbench which includes the deployed configuration details.
Name | Description | Schema |
---|---|---|
backupMetadata |
The Backup Metadata for the workbench. |
|
cloudPlatform |
The cloud platform of the environment that was used to create this workbench. |
string |
clusterID |
The Cluster ID for the workbench. |
string |
creationDate |
Creation date of workbench. |
string (date-time) |
creatorCrn |
The CRN of the creator of the workbench. |
string |
crn |
The CRN of the workbench. |
string |
environmentCrn |
CRN of the environment. |
string |
environmentName |
The name of the workbench’s environment. |
string |
failureMessage |
Failure message from the most recent failure that has occurred during workbench provisioning. |
string |
filesystemID |
A filesystem ID referencing the filesystem that was created on the cloud provider environment that this workbench uses. |
string |
healthInfoLists |
The health info information of the workbench. |
< HealthInfo > array |
httpsEnabled |
Indicates if HTTPs communication was enabled on this workbench when provisioned. |
boolean |
instanceName |
The name of the workbench. |
string |
instanceStatus |
The workbench’s current status. |
string |
instanceUrl |
URL of the workbench’s user interface. |
string |
isPrivate |
The value to indicate if the cluster is private or not. |
boolean |
isRestored |
The value to indicate if the workbench is restored one or not |
boolean |
k8sClusterName |
The Kubernetes cluster name. |
string |
loadBalancerIPWhitelists |
The whitelist of IPs for load balancer. |
< string > array |
monitoringEnabled |
If usage monitoring is enabled or not on this workbench. |
boolean |
nfsVersion |
NFS Version of the filesystem. |
string |
upgradeState |
The upgrade state contains the workbench upgrade information. |
|
version |
The version of Cloudera AI that was installed on the workbench. |
string |