Cloudera AI

appCrn
required

The CRN of the Cloudera AI Inference Service instance to which the instance groups will be added.

string

instanceGroups
required

The instance groups to be added to the Cloudera AI Inference Service instance.

< InstanceGroup > array

instanceGroups
required

The instance groups that we want to add to the workbench.

< InstanceGroup > array

workspaceCrn
required

The CRN of the workbench to which the instance groups are to be added.

string

action
required

Action the user has generated.

string

createdDate
required

Time at creation of event.

string (date-time)

requestID
required

Unique request ID to keep track of event.

string

userCrn
required

UserCrn to track which user has caused the event.

string

workspaceCrn
required

workbench crn where the event observed.

string

events
required

AuditEvent belong to the workbench crn.

< AuditEvent > array

workspaceCrn
required

workbench crn unique for the set of audit events.

string

createdDate
required

Time at which the log is created.

string (date-time)

log
required

Log description.

string

count
required

Total number of logs associated with the request id.

integer (int32)

logs
required

Contains all the logs for a given request id.

< AuditLog > array

requestID
required

The request ID associated with a long-running operation to fetch the logs for.

string

enabled
optional

The boolean flag to enable the auto scaling.

boolean

maxInstances
required

The maximum number of instance for auto scaling.

integer (int32)

minInstances
required

The minimum number of instance for auto scaling.

integer (int32)

backupCrn
optional

The CRN of the backup snapshot.

string

backupName
optional

The name of the backup snapshot.

string

backupStatus
optional

The status of the backup.

string

createdAt
optional

The creation time of the backup snapshot.

string (date-time)

creatorCrn
optional

The CRN of the creator.

string

workspaceVersionAtBackup
optional

The version of the backed-up workbench at the time of backup.

string

backupVaultName
optional

The backup vault name.

string

isSuccessfulBackupAvailable
optional

Whether successful backups are available for the workbench.

boolean

lastBackupStatus
optional

The status of the last backup initiated.

string

lastSuccessfulBackupTime
optional

The time when the last successful backup was taken.

string (date-time)

numberOfAvailableBackups
optional

The number of backups available.

integer (int64)

backupJobTimeoutMinutes
optional

The timeout(in minutes) to use for the execution of the backup jobs.

integer (int32)

backupName
required

Backup name.

string

skipValidation
optional

Skip pre-flight validations if requested.

boolean

workspaceCrn
required

CRN of the workbench to backup.

string

backupCrn
optional

CRN of the backup generated.

string

vaultName
optional

Name of the vault where backup related volumes are stored.

string

appName
required

The name of the Cloudera AI Inference Service to be created.

string

clusterCrn
required

The cluster CRN of an existing cluster where Cloudera AI Inference Service instance will be deployed.

string

environmentCrn
required

The environment CRN.

string

loadBalancerIPWhitelists
optional

The whitelist of IPs for load balancer.

< string > array

provisionK8sRequest
optional

The request for Kubernetes cluster provisioning. Required in public cloud.

MlServingProvisionK8sRequest

skipValidation
optional

Skip pre-flight validations if requested.

boolean

staticSubdomain
optional

The static subdomain to be used for the Cloudera AI Inference Service instance.

string

subnetsForLoadBalancers
optional

The list of subnets to be used for the load balancer.

< string > array

usePublicLoadBalancer
optional

The boolean flag to request a public load balancer. By default, a private load balancer is used.

boolean

appCrn
optional

The CRN of the Cloudera AI Inference Service created.

string

authorizedIPRanges
optional

The whitelist of CIDR blocks which can access the API server.

< string > array

backupCrn
optional

The CRN of the backup that this model registry is created from.

string

creatorCrn
optional

The creator of model registry.

string

environmentCrn
optional

The environment CRN of model registry.

string

environmentName
optional

The environment for the model registry to create.

string

namespace
optional

The namespace of the model registry.

string

outboundTypes
optional

Outbound Types provided for the cluster.

< OutboundTypes > array

privateCluster
optional

Whether to create a private cluster.

boolean

provisionK8sRequest
optional

The request for Kubernetes cluster provision. Required in public cloud.

ModelRegistryProvisionK8sRequest

s3AccessKey
optional

The S3 access key of Ozone.

string

s3Bucket
optional

The s3Bucket of Ozone.

string

s3Endpoint
optional

The endpoint of Ozone.

string

s3SecretKey
optional

The S3 secret key of Ozone.

string

skipValidation
optional

Skip pre-flight validations if requested.

boolean

subnetsForLoadBalancers
optional

The list of subnets used for the load balancer that Cloudera AI creates.

< string > array

usePublicLoadBalancer
optional

The boolean flag to request a public load balancer. By default, a private load balancer is used.

boolean

whitelistAuthorizedIPRanges
optional

Whether to whitelist only authorizedIPRanges given or all public IPs

boolean

authorizedIPRanges
optional

The whitelist of CIDR blocks which can access the API server.

< string > array

cdswMigrationMode
optional

Toggle for cdsw migration preflight validation

string

disableTLS
optional

The boolean flag to disable TLS setup for workbench. By default, the TLS is enabled.

boolean

enableGovernance
optional

Enables Cloudera AI governance by integrating with Cloudera Atlas. By default, this flag is disabled.

boolean

enableModelMetrics
optional

Enables the model metrics service for exporting metrics for models to a metrics store.

boolean

enableMonitoring
optional

The boolean flag is used to enable monitoring. By default, monitoring is disabled.

boolean

environmentName
required

The environment for the workbench to create.

string

existingDatabaseConfig
optional

Optional configurations for an existing Postgres to export model metrics to.

ExistingDatabaseConfig

existingNFS
optional

Optionally use an existing NFS by providing the hostname and desired path (Azure and Private Cloud only).

string

loadBalancerIPWhitelists
optional

The whitelist of IPs for load balancer.

< string > array

mlVersion
optional

The version of ML workload app to install.

string

nfsVersion
optional

The NFS Protocol version of the NFS server we are using for Azure and Private Cloud.

string

outboundTypes
optional

Outbound Types provided for the workbench.

< OutboundTypes > array

privateCluster
optional

Whether to create a private cluster.

boolean

provisionK8sRequest
optional

The request for Kubernetes workbench provision. Required in public cloud.

ProvisionK8sRequest

skipValidation
optional

Skip pre-flight validations if requested.

boolean

staticSubdomain
optional

The static subdomain to be used for the workbench.

string

subnetsForLoadBalancers
optional

The list of subnets used for the load balancer that Cloudera AI creates.

< string > array

usePublicLoadBalancer
optional

The boolean flag to request public load balancer. By default, private load balancer is used.

boolean

whitelistAuthorizedIPRanges
optional

Whether to whitelist only 'authorizedIPRanges' given or all public IPs.

boolean

workspaceName
required

The name of the workbench to create.

string

backupCrn
required

The CRN of the backup to be deleted.

string

skipValidation
optional

Skip pre-flight validations if requested.

boolean

workflowId
optional

The ID of the delete-backup workflow.

string

appCrn
required

The CRN of the Cloudera AI Inference Service from which instance group is to be deleted.

string

instanceGroupName
required

The instance group to be deleted from the Cloudera AI Inference Service instance.

string

instanceGroupName
required

The instance group that we want to delete from the workbench.

string

workspaceCrn
required

The CRN of the workbench from which instance group is to be deleted.

string

appCrn
required

The CRN of the Cloudera AI Inference Service to be deleted.

string

force
optional

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
optional

Deprecated, please use modelRegistryCrn. The environment CRN of the model registry.

string

modelRegistryCrn
optional

CRN of the model registry to be deleted.

string

workspaceCrn
optional

Deprecated. The workbench CRN of the model registry (Public cloud only).

string

environmentName
optional

The environment for the workbench to delete.

string

force
required

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
optional

The remove storage flag indicates weather to keep the backing workbench filesystem storage or remove it during delete.

boolean

workspaceCrn
optional

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
optional

The name of the workbench to delete.

string

appCrn
required

The CRN of the Cloudera AI Inference Service.

string

app
optional

The Cloudera AI Inference Service instance.

MlServingApp

modelRegistryCrn
required

The CRN of the Model Registry to describe.

string

modelRegistry
required

The registry.

ModelRegistry

environmentName
optional

The environment for the workbench to describe.

string

workspaceCrn
optional

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
optional

The name of the workbench to describe.

string

workspace
required

The workbench.

Workspace

code
optional

The error code.

string

message
optional

The error message.

string

existingDatabaseHost
optional

Optionally provide a Postgresql database host to export model metrics to.

string

existingDatabaseName
optional

Optionally provide a Postgresql database name to export model metrics to.

string

existingDatabasePassword
optional

Optionally provide a Postgresql database password to use when exporting model metrics.

string

existingDatabasePort
optional

Optionally provide a Postgresql database port to export model metrics to.

string

existingDatabaseUser
optional

Optionally provide a Postgresql database user to use when exporting model metrics.

string

resourceCrn
optional

Resource crn for which audit events to be fetched. Resource can be workbench or model registry.

string

workspaceCrn
optional

Deprecated, please begin to use Resource crn, as this will soon be unsupported.

string

auditEvents
required

Contains all the audit events for a given workbench crn.

AuditEvents

environmentName
optional

The environment that the workbench is a member of.

string

workspaceCrn
optional

The CRN of the workbench to list access.

string

workspaceName
optional

The name of the workbench to list access.

string

kubeconfig
required

The list of users that have access.

string

version
required

The latest version of a workbench that is used when deploying Cloudera AI workbenches.

string

fetchAll
optional

Flag to fetch all logs.

boolean

offset
optional

offset from which the logs should be fetched.

integer (int32)

pageSize
optional

Limit the number of logs.

integer (int32)

requestID
required

Unique Key to identify a set of logs.

string

workspaceCrn
optional

Deprecated. Please begin to use resourceCrn, as this will soon be unsupported

string

auditLogs
required

Contains all the logs for a given request id.

AuditLogs

appCrn
optional

The CRN of the Cloudera AI Inference Service instance for retrieving the kubeconfig.

string

kubeconfig
required

The kubeconfig of the Cloudera AI Inference Kubernetes cluster.

string

modelRegistryCrn
optional

CRN of the Model Registry

string

kubeConfig
optional

KubeConfig of the model registry cluster

string

identifier
optional

The cloud provider user id, such as ARN, which will be granted access to the Cloudera AI Inference Service Kubernetes cluster.

string

resourceCrn
optional

The CRN of the Cloudera AI Inference Service instance to which access is to be granted.

string

kubeconfig
required

The Kubernetes config file

string

identifier
optional

The cloud provider user id, such as ARN, which will be granted access to the model registry’s Kubernetes cluster.

string

resourceCrn
optional

The CRN of the Model Registry to grant access to.

string

kubeconfig
required

The Kubernetes config file

string

arn
optional

The aws user ARN to grant access to the corresponding EKS cluster. (Deprecated: Use identifier instead).

string

environmentName
optional

The environment that the workbench is a member of.

string

identifier
optional

The cloud provider user id which will be granted access to the workbench’s Kubernetes cluster.

string

workspaceCrn
optional

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
optional

The name of the workbench to grant access to.

string

kubeconfig
required

The Kubernetes config file

string

details
required

The detail of the health info.

< string > array

isHealthy
required