Cloudera Data Engineering API

swagger: '2.0'
x-endpoint-name: de
x-products: CDP
x-form-factors: public,private
x-cdp-releases: PUBLIC
x-audit: true
info:
  version: 0.9.163
  title: Cloudera Data Engineering
  license:
    name: Apache 2.0
  description: Create and manage Cloudera Data Engineering Services.
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /api/v1/de/createBackup:
    post:
      summary: Backup Cloudera Data Engineering(CDE) Service
      description: Initiates service backup and returns a backup ID, which can be used for log retrieval, restoration, deletion, and backup cancellation. Service backup includes the definition of the Service and its Virtual Clusters along with Virtual Clusters contents (jobs, resources, and credentials).
      operationId: createBackup
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateBackupRequest'
      responses:
        200:
          description: Response object for Create Backup command.
          schema:
            $ref: '#/definitions/CreateBackupResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/cancelBackup:
    post:
      summary: Cancel Cloudera Data Engineering(CDE) Service Backup
      description: Cancel a currently running backup operation using the associated backup ID. The operation must be in a 'pending' state.
      operationId: cancelBackup
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CancelBackupRequest'
      responses:
        200:
          description: Response object for Cancel Backup command.
          schema:
            $ref: '#/definitions/CancelBackupResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/deleteBackup:
    post:
      summary: Delete Cloudera Data Engineering(CDE) Service Backup
      description: Delete a backup using the associated backup ID.
      operationId: deleteBackup
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteBackupRequest'
      responses:
        200:
          description: Response object for Delete Backup command.
          schema:
            $ref: '#/definitions/DeleteBackupResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/describeBackup:
    post:
      summary: Describe Cloudera Data Engineering(CDE) Service Backup
      description: Describe a backup using the associated backup ID.
      operationId: describeBackup
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeBackupRequest'
      responses:
        200:
          description: Response object for Describe Backup command.
          schema:
            $ref: '#/definitions/DescribeBackupResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/getBackupLogs:
    post:
      summary: Retrieve Cloudera Data Engineering(CDE) Service Backup Logs
      description: Retrieve backup logs using the associated backup ID.
      operationId: getBackupLogs
      x-paging-default-max-items: 50
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetBackupLogsRequest'
      responses:
        200:
          description: Response object for Get Backup Logs command.
          schema:
            $ref: '#/definitions/GetBackupLogsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/getServiceInitLogs:
    post:
      summary: Retrieve Cloudera Data Engineering(CDE) Service Initialization Logs
      description: Retrieve service initialization logs, if any.
      operationId: getServiceInitLogs
      x-paging-default-max-items: 50
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetServiceInitLogsRequest'
      responses:
        200:
          description: Response object for Get Service Init Logs command.
          schema:
            $ref: '#/definitions/GetServiceInitLogsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/listBackups:
    post:
      summary: List Cloudera Data Engineering(CDE) Service Backups
      description: List all service backups.
      operationId: listBackups
      x-paging-default-max-items: 10
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListBackupsRequest'
      responses:
        200:
          description: Response object for List Backups command.
          schema:
            $ref: '#/definitions/ListBackupsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/restoreService:
    post:
      summary: Restore Cloudera Data Engineering(CDE) Service
      description: Initiates the service restoration process and returns the ID of the service being restored.
      operationId: restoreService
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RestoreServiceRequest'
      responses:
        200:
          description: Response object for Restore Service command.
          schema:
            $ref: '#/definitions/RestoreServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/createVc:
    post:
      summary: Create Virtual Cluster
      description: Creates a virtual cluster and returns creation response.
      operationId: createVc
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateVcRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateVcResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/deleteVc:
    post:
      summary: Delete Virtual Cluster
      description: Deletes a virtual cluster and returns deletion response.
      operationId: deleteVc
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteVcRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteVcResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/updateVc:
    post:
      summary: Update Cloudera Data Engineering (CDE) Virtual Cluster
      description: Updates Cloudera Data Engineering (CDE) Virtual Cluster and returns details of updated CDE service.
      operationId: updateVc
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateVcRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateVcResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/describeService:
    post:
      summary: Describe Cloudera Data Engineering(CDE) Service
      description: Returns details of CDE service.
      operationId: describeService
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/describeVc:
    post:
      summary: Describe Virtual Cluster
      description: Returns a description for the specified virtual cluster.
      operationId: describeVc
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeVcRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeVcResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/disableService:
    post:
      summary: Disable Cloudera Data Engineering(CDE) Service
      description: Returns delete response.
      operationId: disableService
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DisableServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DisableServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/enableService:
    post:
      summary: Enable Cloudera Data Engineering(CDE) Service
      description: Returns enabling response.
      operationId: enableService
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/EnableServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/EnableServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/updateService:
    post:
      summary: Update Cloudera Data Engineering (CDE) Service
      description: Returns update response consisting of operation ID that can be used to log update events.
      operationId: updateService
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/upgradeService:
    post:
      summary: Trigger a particular step (prepare, backup, upgrade, resume) of the upgrade framework.
      description: Trigger a particular step (prepare, backup, upgrade, resume) of the multi-step upgrade process. Use get-upgrade-status to know what is the next step to take.
      operationId: upgradeService
      x-mutating: true
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpgradeServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpgradeServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/getUpgradeStatus:
    post:
      summary: Get CDE Service Upgrade Status.
      description: The current status of the CDE Service upgrade. If all the steps are completed allStepsCompleted would be true. After a particular step triggered by upgrade-service is completed nextStep would point to the next step to take.
      operationId: getUpgradeStatus
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetUpgradeStatusRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetUpgradeStatusResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/getKubeconfig:
    post:
      summary: Get Kubeconfig for the CDE service
      description: Returns kubeconfig.
      operationId: getKubeconfig
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetKubeconfigRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetKubeconfigResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/listServices:
    post:
      summary: List Cloudera Data Engineering(CDE) Services
      description: Returns list of cde services.
      operationId: listServices
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListServicesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListServicesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/listVcs:
    post:
      summary: List Virtual Clusters
      description: Returns a list of virtual clusters for a given CDE service.
      operationId: listVcs
      x-mutating: false
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListVcsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListVcsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/suspendVc:
    post:
      summary: Initiates suspend on the requested VC.
      description: Initiates suspend on the requested VC.
      operationId: suspendVc
      x-mutating: true
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/SuspendVcRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/SuspendVcResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/resumeVc:
    post:
      summary: Initiates resume on the requested VC.
      description: Initiates resume on the requested VC.
      operationId: resumeVc
      x-mutating: true
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ResumeVcRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ResumeVcResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
  /api/v1/de/getSuspendResumeStatus:
    post:
      summary: Get CDE Service Suspend Resume Status.
      description: The current status of the CDE Service suspend/resume process. After a particular step triggered by suspend-resume-service is completed, nextStep would point to the next step to take. If all the steps are completed, allStepsCompleted would be true.
      operationId: getSuspendResumeStatus
      x-mutating: false
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetSuspendResumeStatusRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetSuspendResumeStatusResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
definitions:
  Error:
    type: object
    description: An object returned on an error.
    properties:
      code:
        type: string
        description: The error code.
      message:
        type: string
        description: The error message.
  ServiceSummary:
    type: object
    description: Summary of a CDE service.
    required:
      - name
      - clusterId
      - environmentName
      - status
    properties:
      name:
        type: string
        description: Name of the CDE Service.
      clusterId:
        type: string
        description: Cluster Id of the CDE Service.
      environmentName:
        type: string
        description: CDP Environment Name.
      status:
        type: string
        description: Status of the CDE service.
      creatorEmail:
        type: string
        description: Email Address of the CDE creator.
      enablingTime:
        type: string
        description: Timestamp of service enabling.
  ServiceDescription:
    type: object
    description: Detailed description of a CDE service.
    required:
      - name
      - clusterId
      - environmentName
    properties:
      name:
        type: string
        description: Name of the CDE Service.
      clusterId:
        type: string
        description: Cluster Id of the CDE Service.
      environmentName:
        type: string
        description: CDP Environment Name.
      environmentCrn:
        type: string
        description: CRN of the environment.
      tenantId:
        type: string
        description: CDP tenant ID.
      resources:
        description: Resources details of CDE Service.
        $ref: '#/definitions/ServiceResources'
      status:
        type: string
        description: Status of the CDE service.
      creatorEmail:
        type: string
        description: Email address of the creator of the CDE service.
      creatorCrn:
        type: string
        description: CRN of the creator.
      enablingTime:
        type: string
        description: Timestamp of service enabling.
      clusterFqdn:
        type: string
        description: FQDN of the CDE service.
      cloudPlatform:
        type: string
        description: The cloud platform where the CDE service is enabled.
      dataLakeFileSystems:
        type: string
        description: The Data lake file system.
      logLocation:
        type: string
        description: Location for the log files of jobs.
      backupLocation:
        type: string
        description: Base location for the service backup archives.
      dataLakeAtlasUIEndpoint:
        type: string
        description: Endpoint of Data Lake Atlas.
      chartValueOverrides:
        type: array
        items:
          $ref: '#/definitions/ChartValueOverridesResponse'
        description: Chart overrides for the Virtual Cluster.
      whitelistIps:
        type: string
        description: List of CIDRs that would be allowed to access kubernetes master API server.
      loadbalancerAllowlist:
        type: string
        description: Comma-separated CIDRs that would be allowed to access the load balancer.
      subnets:
        type: string
        description: List of Subnet IDs of the CDP subnets used by the kubernetes worker node.
      privateClusterEnabled:
        type: boolean
        description: If true, the CDE service was created with fully private Azure services (AKS, MySQL, etc.).
      publicEndpointEnabled:
        type: boolean
        description: If true, the CDE endpoint was created in a publicly accessible subnet.
      networkOutboundType:
        type: string
        description: Network outbound type. Currently 'udr' is the only supported.
      previousVersionDeployed:
        type: boolean
        description: The "true" value indicates that the previous version of the CDE service was requested to be deployed.
      workloadAnalyticsEnabled:
        type: boolean
        description: If true, diagnostic information about job and query execution is sent to Cloudera Workload Manager.
      ssdUsed:
        type: boolean
        description: If true, SSD would have been be used for workload filesystem.
      version:
        type: string
        description: The version of the CDE service.
  ServiceResources:
    type: object
    description: Object to store resources for a CDE service.
    properties:
      instance_type:
        type: string
        description: Instance type of the CDE service.
      min_instances:
        type: string
        description: Minimum Instances for the CDE service.
      max_instances:
        type: string
        description: Maximum instances for the CDE service.
      initial_instances:
        type: string
        description: Initial instances for the CDE service.
      min_spot_instances:
        type: string
        description: Minimum number of spot instances for the CDE service.
      max_spot_instances:
        type: string
        description: Maximum Number of Spot instances.
      initial_spot_instances:
        type: string
        description: Initial Spot Instances for the CDE Service.
      root_vol_size:
        type: string
        description: Root Volume Size.
      cpuRequests:
        type: string
        description: CPU Requests for the entire CDE service quota.
        x-form-factors: private
      memoryRequests:
        type: string
        description: Memory requests for the entire CDE service quota, eg. 100Gi.
        x-form-factors: private
      resourcePool:
        type: string
        description: Resource Pool for the CDE service.
        x-form-factors: private
      allPurposeInstanceGroupDetails:
        $ref: '#/definitions/AllPurposeInstanceGroupDetailsResponse'
        description: Resource details for the nodes used in All Purpose Virtual Clusters.
  VcSummary:
    type: object
    description: CDE virtual cluster summary.
    required:
      - vcId
      - vcName
      - clusterId
    properties:
      vcId:
        type: string
        description: Virtual Cluster ID.
      vcName:
        type: string
        description: Name of the CDE Virtual Cluster.
      clusterId:
        type: string
        description: Cluster ID of the CDE service that contains the virtual cluster.
      status:
        type: string
        description: Status of the Virtual Cluster.
      VcUiUrl:
        type: string
        description: Url for the Virtual Cluster UI.
      creatorEmail:
        type: string
        description: Email Address of the Creator.
      creatorName:
        type: string
        description: Name of the Creator.
  VcDescription:
    type: object
    description: CDE virtual cluster summary.
    required:
      - vcId
      - vcName
      - clusterId
    properties:
      vcId:
        type: string
        description: Virtual Cluster ID.
      vcName:
        type: string
        description: Name of the CDE Virtual Cluster.
      clusterId:
        type: string
        description: Cluster ID of the CDE service that contains the Virtual Cluster.
      status:
        type: string
        description: Status of the Virtual Cluster.
      resources:
        description: Resources details of CDE Service.
        $ref: '#/definitions/VcResources'
      creatorEmail:
        type: string
        description: Email address of the creator of Virtual Cluster.
      creatorID:
        type: string
        description: ID of the creator of Virtual Cluster.
      creatorName:
        type: string
        description: Name of the creator of the Virtual Cluster.
      vcApiUrl:
        type: string
        description: Url for the Virtual Cluster APIs.
      VcUiUrl:
        type: string
        description: URL of the CDE Virtual Cluster UI.
      historyServerUrl:
        type: string
        description: Spark History Server URL for the Virtual Cluster.
      livyServerUrl:
        type: string
        description: Livy Server URL for the Virtual Cluster.
      safariUrl:
        type: string
        description: Safari URL for the Virtual Cluster.
      creationTime:
        type: string
        description: Time of creation of the virtual Cluster.
      sparkVersion:
        type: string
        description: Spark version for the virtual cluster.
      sparkOSName:
        type: string
        description: Spark os name for the virtual cluster.
      chartValueOverrides:
        type: array
        items:
          $ref: '#/definitions/ChartValueOverridesResponse'
        description: Chart overrides for the Virtual Cluster.
      accessControl:
        description: Access control object for the Virtual Cluster.
        $ref: '#/definitions/AccessControlResponse'
      smtpConfig:
        description: SMTP Configurations for Airflow Email Alerts.
        $ref: '#/definitions/SmtpConfigResponse'
      vcTier:
        type: string
        description: Tier of the Virtual Cluster.
      sessionTimeout:
        type: string
        description: Default timeout for Sessions.
      sparkConfigs:
        type: object
        description: Spark configs that will be applied to all the spark jobs inside a virtual cluster.
        additionalProperties:
          type: string
          description: Spark configs that will be applied to all the spark jobs inside a virtual cluster.
  VcResources:
    type: object
    properties:
      cpuRequests:
        type: string
        description: The CPU requests for VC for running spark jobs.
      memRequests:
        type: string
        description: The Memory requests for VC for running spark jobs.
      actualCpuRequests:
        type: string
        description: Actual CPU request for the VC. This accounts for other dex apps(eg. livy, airflow), that run in the virtual cluster.
      actualMemoryRequests:
        type: string
        description: Actual Memory request for the VC. This accounts for other dex apps(eg. livy, airflow), that run in the virtual cluster.
    description: Object to store resources for a CDE service
  ChartValueOverridesRequest:
    type: object
    properties:
      chartName:
        type: string
        description: Name of the chart that has to be overridden, for eg- "dex-app", "dex-base".
      overrides:
        type: string
        description: Space separated key-value pairs for overriding chart values. The key and the value must be separated using a colon(:) For eg- "airflow.enabled:true safari.enabled:true".
    description: Object containing chart value overrides for enabling a CDE service or creation of virtual clusters.
  ChartValueOverridesResponse:
    type: object
    properties:
      chartName:
        type: string
        description: Name of the chart that has to be overridden, for eg- "dex-app", "dex-base".
      overrides:
        type: string
        description: Space separated key value-pairs for overriding chart values. The key and the value must be separated using a colon(:) For eg- "airflow.enabled:true safari.enabled:true".
    description: Response object containing chart value overrides.
  AllPurposeInstanceGroupDetailsResponse:
    type: object
    description: Instance group details for the All purpose Tier.
    properties:
      instance_type:
        type: string
        description: Instance type of the cluster for CDE Service.
      min_instances:
        type: string
        description: Minimum number of Instances for the CDE Service.
      max_instances:
        type: string
        description: Maximum number of Instances for the CDE Service.
      min_spot_instances:
        type: string
        description: Minimum number of Spot instances for the CDE Service.
      max_spot_instances:
        type: string
        description: Maximum number of Spot Instances for the CDE Service.
      initial_instances:
        type: string
        description: Initial number of Instances when the service is enabled.
      initial_spot_instances:
        type: string
        description: Initial number of spot Instances when the service is enabled.
      root_vol_size:
        type: string
        description: EBS volume size in GB.
  SmtpConfigRequest:
    type: object
    description: SMTP config request object.
    required:
      - email
      - host
    properties:
      email:
        type: string
        description: Sender's email address.
      host:
        type: string
        description: SMTP host.
      username:
        type: string
        description: SMTP username.
      password:
        type: string
        description: SMTP password.
        x-sensitive: true
      port:
        type: integer
        format: int32
        default: 25
        description: SMTP port.
      startTls:
        type: boolean
        default: true
        description: Use SMTP STARTTLS command to encrypt the mail.
      ssl:
        type: boolean
        default: false
        description: Use SSL to secure the connection to the email server.
  SmtpConfigResponse:
    type: object
    description: SMTP config response object
    required:
      - email
      - host
    properties:
      email:
        type: string
        description: Sender's email address.
      host:
        type: string
        description: SMTP host.
      username:
        type: string
        description: SMTP username.
      port:
        type: integer
        format: int32
        default: 25
        description: SMTP port.
      startTls:
        type: boolean
        default: true
        description: Use SMTP STARTTLS command to encrypt the mail.
      ssl:
        type: boolean
        default: false
        description: Use SSL to secure the connection to the email server.
  AccessControlResponse:
    type: object
    description: Response object containing access control information for a Virtual Cluster.
    properties:
      users:
        description: Workload usernames of CDP users granted access to the Virtual Cluster.
        type: array
        items:
          type: string
      fullAccessUsers:
        description: Users with full access.
        type: array
        items:
          type: string
      fullAccessGroups:
        description: Groups with full access.
        type: array
        items:
          type: string
      viewOnlyUsers:
        description: Users with view only access.
        type: array
        items:
          type: string
      viewOnlyGroups:
        description: Groups with view only access.
        type: array
        items:
          type: string
  ListServicesRequest:
    type: object
    description: Request object for ListServices method.
    properties:
      removeDeleted:
        type: boolean
        default: false
        description: Filter out deleted CDE services from the list.
  EnableServiceRequest:
    type: object
    description: Request object for Enable Service method.
    required:
      - name
      - env
      - instanceType
      - minimumInstances
      - maximumInstances
    properties:
      name:
        type: string
        description: Name of the CDE Service.
      env:
        type: string
        descrip

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/openapi/cloudera-de-openapi.yml