x-generated: Automatically generated by CDP protoc plugin. Do not edit manually.
swagger: '2.0'
x-endpoint-name: onpremises
x-products: CDP
x-form-factors: private,public
x-cdp-releases: BETA
info:
  version: 0.9.165 (BETA)
  title: OnPremises Service
  license:
    name: Apache 2.0
  description: OnPremises Service is a web service to manage the on-prem clusters and control planes.
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /api/v1/onpremises/checkClusterConnectivity:
    post:
      summary: Check cluster connectivity.
      description: Checks the connection between CDP and Cloudera Manager.
      operationId: checkClusterConnectivity
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CheckClusterConnectivityRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CheckClusterConnectivityResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/deleteCluster:
    post:
      summary: Delete a cluster.
      description: Delete a cluster.
      operationId: deleteCluster
      x-form-factors: public,private
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/onpremises/deletePartiallyRegisteredCluster:
    post:
      summary: Delete partially registered cluster.
      description: Delete the partially registered cluster.
      operationId: deletePartiallyRegisteredCluster
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeletePartiallyRegisteredClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeletePartiallyRegisteredClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/onpremises/describeCluster:
    post:
      summary: Get cluster details.
      description: Get details of a registered on-premise cluster.
      operationId: describeCluster
      x-form-factors: public,private
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/describeOnPremControlPlane:
    post:
      summary: Describe a registered Private Cloud control plane configuration.
      description: Describe a registered Private Cloud control plane configuration.
      operationId: describeOnPremControlPlane
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeOnPremControlPlaneRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeOnPremControlPlaneResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/describePartiallyRegisteredCluster:
    post:
      summary: Describes the partially registered cluster.
      description: Describes the partially registered cluster.
      operationId: describePartiallyRegisteredCluster
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribePartiallyRegisteredClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribePartiallyRegisteredClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/extractCertificateRefreshScript:
    post:
      summary: Extract certificate refresh script package.
      description: Extract certificate refresh script to get updated certificate.
      operationId: extractCertificateRefreshScript
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ExtractCertificateRefreshScriptRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ExtractCertificateRefreshScriptResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/extractClusters:
    post:
      summary: Extract clusters
      description: Extracts cluster information by using authenticated access to the cluster-manager.
      operationId: extractClusters
      x-form-factors: public,private
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ExtractClustersRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ExtractClustersResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/generateClusterConnectivityAgentConfig:
    post:
      summary: Generate the cluster connectivity config.
      description: Generates a ZIP file containing all necessary files to set up cluster connectivity.
      operationId: generateClusterConnectivityAgentConfig
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GenerateClusterConnectivityAgentConfigRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GenerateClusterConnectivityAgentConfigResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
      x-api-resource-response: true
      produces:
        - application/octet-stream
  /api/v1/onpremises/getClusterConnectivityAgentPackageUrl:
    post:
      summary: Get cluster connectivity agent package url.
      description: Provide suitable agent package url.
      operationId: getClusterConnectivityAgentPackageUrl
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetClusterConnectivityAgentPackageUrlRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetClusterConnectivityAgentPackageUrlResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/listClusterServices:
    post:
      summary: List service details of a cluster.
      description: Gets the service details of a cluster.
      operationId: listClusterServices
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListClusterServicesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListClusterServicesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/listClusters:
    post:
      summary: Lists all registered clusters.
      description: Lists all registered on-premise clusters.
      operationId: listClusters
      x-paging-default-max-items: 20
      x-form-factors: public,private
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListClustersRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListClustersResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/listLocations:
    post:
      summary: List the locations and its details.
      description: List the locations and its details.
      operationId: listLocations
      x-paging-default-max-items: 20
      x-form-factors: public,private
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListLocationsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListLocationsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/listOnPremControlPlanes:
    post:
      summary: List registered Private Cloud control plane configurations.
      description: List registered Private Cloud control plane configurations.
      operationId: listOnPremControlPlanes
      x-paging-default-max-items: 20
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListOnPremControlPlanesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListOnPremControlPlanesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/listPartiallyRegisteredClusters:
    post:
      summary: List partially registered clusters.
      description: API to list all the partially registered clusters.
      operationId: listPartiallyRegisteredClusters
      x-paging-default-max-items: 20
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListPartiallyRegisteredClustersRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListPartiallyRegisteredClustersResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/registerCluster:
    post:
      summary: Register an existing cluster
      description: Register an existing cluster as an on-premise cluster.
      operationId: registerCluster
      x-form-factors: public,private
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RegisterClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RegisterClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/onpremises/registerOnPremControlPlane:
    post:
      summary: Register a Private Cloud control plane.
      description: Register a Private Cloud control plane in Public Cloud.
      operationId: registerOnPremControlPlane
      x-right: onpremises/registerOnPremControlPlane
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RegisterOnPremControlPlaneRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RegisterOnPremControlPlaneResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/onpremises/rotateAgentCredentials:
    post:
      summary: Rotates the agent credentials.
      description: Rotates the Jumpgate Agent's credentials in PvC.
      operationId: rotateAgentCredentials
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RotateAgentCredentialsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RotateAgentCredentialsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/onpremises/syncClusterData:
    post:
      summary: Syncs the remote cluster data with the latest cluster service details.
      description: Syncs the remote cluster data with the latest cluster service details.
      operationId: syncClusterData
      x-form-factors: public,private
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/SyncClusterDataRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/SyncClusterDataResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/onpremises/testOnPremControlPlaneConnectivity:
    post:
      summary: Test the connectivity to the Private Cloud control plane.
      description: Test the connectivity from Public Cloud control plane to the registered Private Cloud control plane.
      operationId: testOnPremControlPlaneConnectivity
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/TestOnPremControlPlaneConnectivityRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/TestOnPremControlPlaneConnectivityResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/onpremises/unregisterOnPremControlPlane:
    post:
      summary: Unregister a Private Cloud control plane.
      description: Unregister a Private Cloud control plane from the Public Cloud, and clean up the Public Cloud resources from Private Cloud control plane resulting complete termination of the connection.
      operationId: unregisterOnPremControlPlane
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UnregisterOnPremControlPlaneRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UnregisterOnPremControlPlaneResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/onpremises/updateCluster:
    post:
      summary: Update an existing cluster
      description: Update registration of an on-premise cluster.
      operationId: updateCluster
      x-form-factors: public,private
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateClusterRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateClusterResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/onpremises/updateOnPremControlPlane:
    post:
      summary: Update the Private Cloud control plane registration.
      description: Update the Private Cloud control plane registration in Public Cloud.
      operationId: updateOnPremControlPlane
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateOnPremControlPlaneRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateOnPremControlPlaneResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/onpremises/validateClusterForDatalake:
    post:
      summary: Validate cluster for datalake.
      description: Validate if a classic-cluster can be used as datalake.
      operationId: validateClusterForDatalake
      x-form-factors: public
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ValidateClusterForDatalakeRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ValidateClusterForDatalakeResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
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.
  ListClustersRequest:
    type: object
    description: Request object for the ListClusters method.
    properties:
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 500
        x-paging-page-size: true
        description: The page size.
      pageToken:
        type: string
        x-paging-input-token: true
        description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
      managerType:
        description: Manager type of the cluster.
        $ref: '#/definitions/ClusterManagerType'
      services:
        type: array
        items:
          type: string
        description: Services in the cluster.
      operator:
        description: Operator on which the filters should be applied.
        $ref: '#/definitions/ClusterQueryOperator'
      clusterType:
        description: Type of the cluster.
        $ref: '#/definitions/ClusterType'
      clusterState:
        description: State of the cluster.
        $ref: '#/definitions/ClusterState'
    x-form-factors: public,private
  ListClustersResponse:
    type: object
    description: Response object for the ListClusters method.
    properties:
      nextPageToken:
        type: string
        x-paging-output-token: true
        description: The token to use when requesting the next set of results. If not present, there are no additional results.
      clusters:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/Cluster'
        description: List of clusters.
    x-form-factors: public,private
  RegisterClusterRequest:
    type: object
    description: Request object for the RegisterCluster method.
    required:
      - datacenterName
      - managerUri
    properties:
      datacenterName:
        type: string
        maxLength: 32
        description: The data center name of the registered on-premise cluster.
      managerUri:
        type: string
        description: The manager URI of the on-premise cluster.
      username:
        type: string
        description: The user name for the cluster.
      password:
        type: string
        description: The password for the cluster.
        x-sensitive: true
      name:
        type: string
        description: Name of the cluster. Should match the name it uses in Cloudera Manager (or Ambari).
      locationId:
        type: integer
        format: int64
        description: The location of the cluster.
      tags:
        type: array
        items:
          type: string
        description: Tags associated with the registration
      description:
        type: string
        maxLength: 1000
        description: Description of the onpremises cluster
      environmentCrn:
        type: string
        description: The CRN of the Private Cloud environment.
    x-form-factors: public,private
  RegisterClusterResponse:
    type: object
    description: Response object for the RegisterCluster method.
    required:
      - clusterCrn
    properties:
      clusterCrn:
        type: string
        description: The CRN of registered on-premise cluster.
    x-form-factors: public,private
  UpdateClusterRequest:
    type: object
    description: Request object for the UpdateCluster method.
    required:
      - clusterCrn
    properties:
      clusterCrn:
        type: string
        description: The CRN of registered on-premise cluster.
      username:
        type: string
        description: The user name for the cluster.
      password:
        type: string
        description: The password for the cluster.
        x-sensitive: true
      locationId:
        type: integer
        format: int64
        description: The location of the cluster.
      tags:
        type: array
        items:
          type: string
        description: Tags associated with the registration
    x-form-factors: public,private
  UpdateClusterResponse:
    type: object
    description: Response object for the UpdateCluster method.
    required:
      - clusterCrn
    properties:
      clusterCrn:
        type: string
        description: CRN of the registered on-premise cluster.
    x-form-factors: public,private
  DescribeClusterRequest:
    type: object
    description: Request object for the DescribeCluster method.
    properties:
      clusterCrn:
        type: string
        description: The CRN of the cluster.
      showOnPremiseEnvironmentDetails:
        type: boolean
        description: Whether to show On Premise environment details.
    x-form-factors: public,private
  HostDistribution:
    type: object
    description: OS distribution details for a cluster host collected from Cloudera Manager during sync.
    properties:
      distributionType:
        type: string
        description: The OS distribution type reported by Cloudera Manager (for example, RHEL9).
      name:
        type: string
        description: The OS distribution name reported by Cloudera Manager (for example, redhat).
      version:
        type: string
        description: The OS distribution version reported by Cloudera Manager (for example, 9.4).
    x-form-factors: public,private
  ClusterHostSummary:
    type: object
    description: Host summary details collected from Cloudera Manager during sync.
    properties:
      hostname:
        type: string
        description: The hostname (FQDN) of the cluster host.
      ipAddress:
        type: string
        description: The IP address of the cluster host.
      status:
        type: string
        description: The commission state of the host in Cloudera Manager.
      hostId:
        type: string
        description: The Cloudera Manager host ID.
      distribution:
        description: The OS distribution details for the host.
        $ref: '#/definitions/HostDistribution'
    x-form-factors: public,private
  DescribeClusterResponse:
    type: object
    description: Response object for the DescribeCluster method.
    properties:
      cluster:
        description: Object containing cluster details.
        $ref: '#/definitions/Cluster'
      hosts:
        type: array
        items:
          $ref: '#/definitions/ClusterHostSummary'
        description: Host summary details collected from Cloudera Manager during sync.
    x-form-factors: public,private
  ValidateClusterForDatalakeRequest:
    type: object
    description: Request object for the ValidateClusterForDatalake method.
    required:
      - clusterCrn
    properties:
      clusterCrn:
        type: string
        description: The CRN of the cluster.
    x-form-factors: public
  ValidateClusterForDatalakeResponse:
    type: object
    description: Response object for the ValidateClusterForDatalake method.
    required:
      - isValidForDatalake
    properties:
      isValidForDatalake:
        type: boolean
        description: Indicates whether the cluster can be used as a Data Lake.
      validations:
        type: array
        items:
          $ref: '#/definitions/DatalakeValidation'
        description: Validation results (passed/failed) with optional messages.
    x-form-factors: public
  DatalakeValidation:
    type: object
    description: Datalake validation result.
    properties:
      type:
        description: Validation type.
        $ref: '#/definitions/DatalakeValidationType'
      passed:
        type: boolean
        description: Whether this validation passed.
      message:
        type: string
        description: Human-readable message (typically empty for passed validations; includes reason for failures).
    x-form-factors: public,private
  DatalakeValidationType:
    type: string
    description: "The type of datalake validation.\n `CLUSTER_TYPE_CDPDC` - Cluster type is CDPDC. `CLOUDERA_RUNTIME_VERSION_AT_LEAST_7_1_9` - Cloudera Runtime is 7.1.9 or newer. `KERBERIZED` - Whether kerberized or not. `NOT_COMPUTE_CLUSTER` - The clusterType should not be \"COMPUTE\" for virtual private cluster."
    enum:
      - CLUSTER_TYPE_CDPDC
      - CLOUDERA_RUNTIME_VERSION_AT_LEAST_7_1_9
      - KERBERIZED
      - NOT_COMPUTE_CLUSTER
    x-form-factors: public,private
  ListClusterServicesRequest:
    type: object
    description: Request object for the ListClusterServices method.
    required:
      - clusterCrn
    properties:
      clusterCrn:
        type: string
        description: CRN of the registered on-premise cluster.
      clusterName:
        type: string
        description: Name of the cluster in the cloudera-manager.
      managerUri:
        type: string
        description: CRN of the registered on-premise cluster.
      username:
        type: string
        description: Username of the cloudera-manager.
      password:
        type: string
        description: Password of the cloudera-manager.
        x-sensitive: true
    x-form-factors: public
  ListClusterServicesResponse:
    type: object
    description: Response object for the ListClusterServices method.
    properties:
      services:
        type: array
        items:
          $ref: '#/definitions/ClusterService'
        description: List of service detail information.
    x-form-factors: public
  ExtractClustersRequest:
    type: object
    description: Request object for the ExtractClusters method.
    required:
      - managerUri
      - username
      - password
    properties:
      managerUri:
        type: string
        description: The manager URI of the on-premise cluster.
      username:
        type: string
        description: The user name for the cluster.
      password:
        type: string
        description: The password for the cluster.
        x-sensitive: true
      clusterCrn:
        type: string
        description: The CRN of the cluster.
    x-form-factors: public,private
  ExtractClustersResponse:
    type: object
    description: Response object for the ExtractClusters method.
    properties:
      clusters:
        type: array
        items:
          $ref: '#/definitions/ClusterDiscovered'
        description: List of clusters attached to the provided cluster-manager.
    x-form-factors: public,private
  ListLocationsRequest:
    type: object
    description: Location request object containing the regex pattern.
    properties:
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 500
        x-paging-page-size: true
        description: The page size.
      pageToken:
        type: string
        x-paging-input-token: true
        description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
      query:
        type: string
        description: Regex pattern for location.
    x-form-factors: public,private
  ListLocationsResponse:
    type: object
    description: Location response object containing the location details.
    properties:
      pageToken:
        type: string
        x-paging-output-token: true
        description: The token to use when requesting the next set of results. If not present, there are no additional results.
      locations:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/Location'
        description: Location response message.
    x-form-factors: public,private
  SyncClusterDataResponse:
    type: object
    description: Response object for the SyncClusterData method.
    properties:
      syncSuccessful:
        type: boolean
        description: Boolean object returning the status of the sync operation.
    x-form-factors: public,private
  SyncClusterDataRequest:
    type: object
    description: Request object for the SyncClusterData method.
    properties:
      clusterCrn:
        type: string
        description: The CRN of the cluster on which the sync operation should be performed.
    x-form-factors: public,private
  DeleteClusterRequest:
    type: object
    description: Request for delete remote cluster.
    properties:
      name:
        type: string
        description: The remote cluster name.
      dcName:
        type: string
        description: The remote cluster data center name.
    x-form-factors: public,private
  DeleteClusterResponse:
    type: object
    description: Response for delete remote cluster.
    x-form-factors: public,private
  ListPartiallyRegisteredClustersRequest:
    type: object
    description: Request object for listing the partially registered clusters.
    properties:
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 500
        x-paging-page-size: true
        description: The page size.
      pageToken:
        type: string
        x-paging-input-token: true
        description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
    x-form-factors: public
  ListPartiallyRegisteredClustersResponse:
    type: object
    description: Response object for listing the partially registered clusters.
    properties:
      partiallyRegisteredClusterData:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/PartiallyRegisteredClusterData'
        description: Details of the partially registered cluster data
      nextPageToken:
        type: string
        x-paging-output-token: true
        description: The token to use when requesting the next set of results. If not present, there are no additional results.
    x-form-factors: public
  ExtractCertificateRefreshScriptRequest:
    type: object
    description: Request object for extract certificate refresh script
    x-form-factors: public
  ExtractCertificateRefreshScriptResponse:
    type: object
    description: Response object for extract certificate refresh script
    properties:
      refreshPackage:
        type: string
        format: byte
        description: Raw zip file bytes containing the refresh script and certificate
        x-skip-logging: true
      filename:
        type: string
        description: Package filename
    x-form-factors: public
  CheckClusterConnectivityRequest:
    type: object
    description: Request object for extract setup script API.
    properties:
      clusterCrn:
        type: string
        description: The CRN of the cluster.
    x-form-factors: public
  CheckClusterConnectivityResponse:
    type: object
    description: Response object for extract setup script API.
    x-form-factors: public
  DeletePartiallyRegisteredClusterRequest:
    type: object
    description: Request object for deleting the partially registered cluster API.
    properties:
      clusterCrn:
        type: string
        description: The cluster CRN of the on-premise cluster.
    x-form-factors: public
  DeletePartiallyRegisteredClusterResponse:
    type: object
    description: Response object for deleting the partially registered cluster API.
    x-form-factors: public
  PartiallyRegisteredClusterData:
    type: object
    description: Object holding the partially registered on-premise cluster data
    properties:
      id:
        type: integer
        format: int64
        description: The ID of the partially registered on-premise cluster.
      clusterCrn:
        type: string
        description: The cluster CRN of the on-premise cluster.
      datacenterName:
        type: string
        description: The datacenter name of the on-premise cluster.
      ipAddress:
        type: string
        description: The IP Address of the on-premise cluster (same as Cloudera Manager IP address).
      port:
        type: integer
        format: int32
        description: The port at which the cloudera manager is accessible.
      clusterType:
        type: string
        description: The type of the partially registered cluster. It will be either CDPDC or CDH.
      isSecure:
        type: boolean
        description: Boolean value to determine if the cluster is secure.
      clusterConnectivityState:
        type: string
        description: State of the cluster connectivity of the partially registered cluster. It will be either FAILED, IN-PROGRESS, READY.
      createdBy:
        type: string
        description: The CRN of the user who triggered the registration request.
      createdAt:
        type: string
        format: date-time
        description: The time at which the registration was triggered.
      updatedAt:
        type: string
        format: date-time
        description: The time at which the registration was updated.
      registrationStatus:
        type: string
        description: Registration Status of the partially registered on-premises cluster.
      agentCrn:
        type: string
        description: CRN of the jumpgate agent.
      pvcCrn:
        type: string
        description: CRN of the Private Cloud Control plane.
    x-form-factors: public,private
  GenerateClusterConnectivityAgentConfigRequest:
    type: object
    description: Request for GenerateClusterConnectivityAgentConfig call.
    required:
      - datacenterName
      - clusterType
      - cmUrl
    properties:
      datacenterName:
        type: string
        maxLength: 32
        description: Datacenter name of the cluster.
      clusterType:
        description: The type of the cluster.
        $ref: '#/definitions/ClusterType'
      cmUrl:
        type: string
        description: URL of the cloudera manager
    x-form-factors: public
  GenerateClusterConnectivityAgentConfigResponse:
    type: object
    description: Response for GenerateClusterConnectivityAgentConfig call.
    properties:
      setupPackage:
        type: string
        format: byte
        description: Raw zip file bytes containing the script and keys.
        x-skip-logging: true
    x-form-factors: public
  DescribePartiallyRegisteredClusterRequest:
    type: object
    description: Request body for the partially registered cluster.
    properties:
      clusterCrn:
        type: string
        description: Cluster CRN of the partially registered cluster. Should be used alone.
      datacenterName:
        type: string
        description: Datacenter name of the partially registered cluster. Should be used alone.
    x-form-factors: public
  DescribePartiallyRegisteredClusterResponse:
    type: object
    description: Response body for the partially registered cluster.
    properties:
      partiallyRegisteredClusterData:
        description: Details of the partially registered cluster.
        $ref: '#/definitions/PartiallyRegisteredClusterData'
    x-form-factors: public
  Cluster:
    type: object
    description: Object containing the cluster information.
    properties:
      clusterCrn:
        type: string
        description: The clusterCrn of the registered cluster.
      name:
        type: string
        description: The name of the registered cluster.
      datacenterName:
        type: string
        description: The data center name of the registered cluster.
      id:
        type: integer
        format: int64
        description: The clusterId of the registered cluster.
      ipAddress:
        type: string
        description: The IP address of the registered cluster.
      clusterType:
        description: The type of the registered cluster.
        $ref: '#/definitions/ClusterType'
      state:
        description: The active status of the registered cluster.
        $ref: '#/definitions/ClusterState'
      description:
        type: string
        description: The description of the registered cluster.
      lastCreateTime:
        type: string
        format: date-time
        description: The time at which the cluster was registered.
      lastUpdatedTime:
        type: string
        format: date-time
        description: The time at which the cluster was updated.
      updatedUtc:
        type: string
        format: date-time
        description: The time at which the cluster was updated. Its value is in Coordinated Universal Time.
      data:
        description: Details of cluster read from cluster-manager.
        $ref: '#/definitions/ClusterData'
      username:
        type: string
        description: The user name of the cluster.
      password:
        type: string
        description: The password of the cluster.
        x-sensitive: true
      allowUntrusted:
        type: boolean
        description: Indicates if the service should make untrusted connections (without verifying TLS) to the cluster.
      managerType:
        description: The manager type of the registered cluster.
        $ref: '#/definitions/ClusterManagerType'
      managerUri:
        type: string
        description: The manager URI of the registered cluster.
      createdBy:
        type: string
        description: The owner of the registered cluster.
      newKeyId:
        type: string
        description: The key ID of the registered cluster.
      location:
        description: The location of the data center.
        $ref: '#/definitions/Location'
      properties:
        type: string
        description: The properties of the particular cluster as a JSON string.
      cmClusterUuid:
        type: string
        description: The UUID of the CM Base Cluster.
      environmentCrn:
        type: string
        description: The CRN of the Private Cloud environment.
      pvcCrn:
        type: string
        description: CRN of the Private Cloud Control plane.
      onPremEnvironmentDetails:
        description: Cloudera on-premises environment details. Only returned when showOnPremiseEnvironmentDetails in DescribeClusterRequest is true.
        $ref: '#/definitions/OnPremEnvironmentDetails'
    x-form-factors: public,private
  OnPremEnvironmentDetails:
    type: object
    description: Object containing the on-premises Environment details.
    properties:
      cmHost:
        type: string
        description: Cloudera Manager Host.
      applications:
        type: object
        description: A map of applications that provide services for the Service Discovery.
        additionalProperties:
          $ref: '#/definitions/Application'
      cmVersion:
        type: string
        description: Cloudera Manager Version.
      clouderaRuntimeVersion:
        type: string
        description: Cloudera Runtime Version.
      onPremDatalakeDetails:
        description: On-premises Data Lake details.
        $ref: '#/definitions/OnPremDatalakeDetails'
    x-form-factors: public,private
  Application:
    type: object
    description: Object containing the details of a service discovery application.
    properties:
      name:
        type: string
        description: Name of the application.
      services:
        type: object
        description: The services provided by the application.
        additionalProperties:
          $ref: '#/definitions/Service'
      config:
        type: object
        description: Configuration key values for an application.
        additionalProperties:
          type: string
    x-form-factors: public,private
  Service:
    type: object
    description: Object containing the details of a service discovery service.
    properties:
      type:
        type: string
        description: Type of service.
      endpoints:
        type: array
        items:
          $ref: '#/definitions/ServiceEndpoint'
        description: List of endpoints that the service presents.
      config:
        type: object
        description: Configuration key values for a service.
        additionalProperties:
          type: string
    x-form-factors: public,private
  ServiceEndpoint:
    type: object
    description: Object containing the details of endpoint of a Service Discovery Service.
    properties:
      host:
        type: string
        description: Endpoint hostname or IP address.
      port:
        type: integer
        format: int32
        description: Endpoint port.
      uri:
        type: string
        description: Connection URI of the endpoint.
    x-form-factors: public,private
  OnPremDatalakeDetails:
    type: object
    description: Object containing on-premises Data Lake details.
    properties:
      datalakeName:
        type: string
        description: Name of the Data Lake.
      enableRangerRaz:
        type: boolean
        description: Inidicates whether Ranger RAZ is enabled for the Data Lake.
      creationTimeEpochMillis:
        type: integer
        format: int64
        description: The timestamp in Unix epoch when the Data Lake was created.
      cmFqdn:
        type: string
        description: The Cloudera Manager FQDN.
      cmIp:
        type: string
        description: The Cloudera Manager IP.
      cmServerId:
        type: string
        description: The Cloudera Manager server ID.
      status:
        description: Status of the Data Lake.
        $ref: '#/definitions/DatalakeStatus'
      instances:
        type: array
        items:
          $ref: '#/definitions/Instance'
        description: The list of instances within the on premises Data Lake cluster.
      kerberosInfo:
        description: Contains the kerberos related informations.
        $ref: '#/definitions/KerberosInfo'
    x-form-factors: public,private
  Instance:
    type: object
    description: Information for instance within the on premises Data Lake cluster.
    properties:
      id:
        type: string
        description: The ID of the instance.
      fqdn:
        type: string
        description: The fully qualified domain name of the instance in the cluster.
      privateIp:
        type: string
        description: The private IP of the instance.
    x-form-factors: public,private
  KerberosInfo:
    type: object
    description: The kerberos information for on premises Data Lake cluster.
    properties:
      kdcType:
        type: string
        description: The type of Key Distribution Center.
      kerberosRealm:
        type: string
        description: Kerberos realm.
      kdcHost:
        type: string
        description: Key Distribution Center host.
      kerberized:
        type: boolean
        description: Denotes whether kerberized or not.
    x-form-factors: public,private
  DatalakeStatus:
    type: string
    description: "Status of the on-premises Data Lake.\n `AVAILABLE` - Data Lake is available. `NOT_AVAILABLE` - Data Lake is unavailable."
    enum:
      - AVAILABLE
      - NOT_AVAILABLE
    x-form-factors: public,private
  ClusterService:
    type: object
    description: Object containing the service information.
    properties:
      name:
        type: string
        description: Name of the service.
      version:
        type: string
        description: Version of the service.
      state:
        type: string
        description: State of the service.
      serviceUrl:
        type: string
        description: URL of the service in Cloudera Manager.
    x-form-factors: public,private
  ClusterData:
    type: object
    description: Object containing the discovered cluster information.
    properties:
      name:
        type: string
        description: The name of the cluster.
      version:
        type: string
        description: The version of the cluster.
      displayName:
        type: string
        description: The display name of the discovered cluster.
      url:
        type: string
        description: The cluster URL of the discovered cluster.
      secured:
        type: boolean
        description: Indicates if the cluster is secured or not.
      kerberosUser:
        type: string
        description: The Kerberos user of the cluster.
      kerberosTicketLocation:
        type: string
        description: The Kerberos ticket location of the cluster.
      clusterDetails:
        description: Cluster details.
        $ref: '#/definitions/ClusterDetails'
      stats:
        type: string
        description: The stats of the discovered cluster.
    x-form-factors: public,private
  Location:
    type: object
    description: Object containing the location of the data center.
    properties:
      id:
        type: integer
        format: int64
        description: ID of the location.
      city:
        type: string
        description: City in which the data center is located.
      province:
        type: string
        description: Province in which the data center is located.
      country:
        type: string
        description: Country in which the data center is located.
      iso2:
        type: string
        description: ISO2 of the location.
      latitude:
        type: string
        description: Latitude of the location.
      longitude:
        type: string
        description: Longitude of the location.
    x-form-factors: public,private
  ClusterDetails:
    type: object
    description: Object containing cluster details.
    properties:
      name:
        type: string
        description: Name of the cluster.
      displayName:
        type: string
        description: Display name of the cluster.
      version:
        type: string
        description: Cluster version.
      fullVersion:
        type: string
        description: Full version of the cluster.
      clusterUrl:
        type: string
        description: URL of the cluster.
      hostsUrl:
        type: string
        description: The URL to access hosts of this cluster.
      entityStatus:
        description: The entity status for the cluster.
        $ref: '#/definitions/EntityStatus'
      uuid:
        type: string
        description: Uuid of the cluster.
      clouderaManagerClusterType:
        description: The type of cluster. Possible values are BASE_CLUSTER or COMPUTE_CLUSTER.
        $ref: '#/definitions/ClouderaManagerClusterType'
    x-form-factors: public,private
  ClusterDiscovered:
    type: object
    description: Details of attached cluster.
    properties:
      name:
        type: string
        description: Name of cluster as returned from the cluster-manager.
    x-form-factors: public,private
  GetClusterConnectivityAgentPackageUrlRequest:
    type: object
    description: Request for GetClusterConnectivityAgentPackageUrl
    properties:
      kind:
        description: Use suitable kind based on OS.
        $ref: '#/definitions/ClusterConnectivityAgentPackageKind'
    x-form-factors: public
  GetClusterConnectivityAgentPackageUrlResponse:
    type: object
    description: Response for GetClusterConnectivityAgentPackageUrl
    properties:
      agentUrl:
        type: string
        description: Cluster connectivity agent package url.
    x-form-factors: public
  ClusterConnectivityAgentPackageKind:
    type: string
    description: "OS of Cloudera manager host.\n `JUMPGATE_RPM_LEGACY_EL6` - Used for CentOS 6 / RHEL 6. `JUMPGATE_RPM_STANDARD` - Used for CentOS 7 / CentOS 8 / RHEL 7 / RHEL 8 / RHEL 9 / Suse 15.4. `JUMPGATE_DEB_UBUNTU` - Used for Ubuntu 20.04"
    enum:
      - JUMPGATE_RPM_LEGACY_EL6
      - JUMPGATE_RPM_STANDARD
      - JUMPGATE_DEB_UBUNTU
    x-form-factors: public,private
  ClusterState:
    type: string
    description: "State of the on-premise cluster.\n `TO_SYNC` - Cluster yet to be synced. `SYNC_IN_PROGRESS` - Cluster sync in-progress. `SYNCED` - Cluster sync successful. `SYNC_ERROR` - Cluster sync error."
    enum:
      - TO_SYNC
      - SYNC_IN_PROGRESS
      - SYNCED
      - SYNC_ERROR
    x-form-factors: public,private
  ClusterManagerType:
    type: string
    description: "Manager type of the cluster.\n `AMBARI` - Ambari as manager type. `CLOUDERA_MANAGER` - Cloudera Manager as manager type."
    enum:
      - AMBARI
      - CLOUDERA_MANAGER
    x-form-factors: public,private
  ClusterType:
    type: string
    description: "The type of on-premise cluster.\n `CDH` - Legacy CDH Cluster. `CDPDC` - CDPDC Cluster."
    enum:
      - CDH
      - CDPDC
    x-form-factors: public,private
  ClouderaManagerClusterType:
    type: string
    description: "The type of cluster. If unspecified, defaults to either BASE_CLUSTER (if no data contexts are provided) or COMPUTE_CLUSTER (if one or more data contexts are provided).\n `BASE_CLUSTER` - CDP Base cluster being managed by Cloudera Manager. `COMPUTE_CLUSTER` - OnPremises containerized compute cluster being managed by the Cloudera control plane."
    enum:
      - BASE_CLUSTER
      - COMPUTE_CLUSTER
    x-form-factors: public,private
  ClusterQueryOperator:
    type: string
    description: "The type of operator.\n `AND` - AND operator. `OR` - OR operator."
    enum:
      - AND
      - OR
    x-form-factors: public,private
  EntityStatus:
    type: string
    description: "The single value used by the Cloudera Manager to represent the status of the entity.\n `UNKNOWN` - Unknown. `NONE` - None. `STOPPED` - Stopped. `DOWN` - Down. `UNKNOWN_HEALTH` - Unknown health. `DISABLED_HEALTH` - Disabled health. `CONCERNING_HEALTH` - Concerning health. `BAD_HEALTH` - Bad health. `GOOD_HEALTH` - Good health. `STARTING` - Starting. `STOPPING` - Stopping. `HISTORY_NOT_AVAILABLE` - History not available."
    enum:
      - UNKNOWN
      - NONE
      - STOPPED
      - DOWN
      - UNKNOWN_HEALTH
      - DISABLED_HEALTH
      - CONCERNING_HEALTH
      - BAD_HEALTH
      - GOOD_HEALTH
      - STARTING
      - STOPPING
      - HISTORY_NOT_AVAILABLE
    x-form-factors: public,private
  RegisterOnPremControlPlaneRequest:
    type: object
    description: Request object for the RegisterOnPremControlPlaneRequest method.
    required:
      - pvcId
      - name
      - baseUrl
      - samlIdentityProvider
    properties:
      pvcId:
        type: string
        description: The account ID of the Private Cloud control plane.
      name:
        type: string
        maxLength: 128
        description: The name of the Private Cloud control plane.
      baseUrl:
        type: string
        description: The base URL of the Private Cloud control plane.
        x-no-paramfile: true
      samlIdentityProvider:
        type: string
        description: The name or ID or CRN of the SAML identity provider from Public Cloud control plane in which users are allowed to operate on the Private Cloud control plane. The same or equivalent SAML IDP should be used by the Public Cloud control plane and the Private Cloud control plane, in order for the user to be mapped by SAML user ID.
      description:
        type: string
        maxLength: 1000
        description: The description of the Private Cloud control plane.
    x-form-factors: public
  RegisterOnPremControlPlaneResponse:
    type: object
    description: Response object for the RegisterOnPremControlPlaneResponse method.
    properties:
      controlPlaneConfiguration:
        description: The Private Cloud control plane configuration.
        $ref: '#/definitions/OnPremControlPlaneConfiguration'
      connectivityConfiguration:
        type: string
        description: The connectivity configuration to be used by the Private Cloud control plane.
    x-form-factors: public
  UnregisterOnPremControlPlaneRequest:
    type: object
    description: Request object for the UnregisterOnPremControlPlaneRequest method.
    required:
      - pvc
    properties:
      pvc:
        type: string
        description: The account ID or CRN of the Private Cloud control plane.
      unregisterOnPremClusters:
        type: boolean
        description: Set to `true` to unregister on premises clusters. Defaults to `false` if not set. if `false` on premises clusters will not be unregistered.
      force:
        type: boolean
        description: Set to `true` to enable force unregister, This option may be used when on premises control plane connection has failed or the delete operation is failing. This option only guarantees to remove this instance from cloud control plane, and may leave hybrid connection lingering on on premises control plane. You may have to delete the connection from on premises control plane manually for complete cleanup. Defaults to `false` if not set.
    x-form-factors: public
  UnregisterOnPremControlPlaneResponse:
    type: object
    description: Response object for the UnregisterOnPremControlPlaneResponse method.
    x-form-factors: public
  DescribeOnPremControlPlaneRequest:
    type: object
    description: Request object for the DescribeOnPremControlPlaneRequest method.
    required:
      - pvc
    properties:
      pvc:
        type: string
        description: The account ID or CRN of the Private Cloud control plane.
    x-form-factors: public
  DescribeOnPremControlPlaneResponse:
    type: object
    description: Response object for the DescribeOnPremControlPlaneResponse method.
    properties:
      controlPlaneConfiguration:
        description: The Private Cloud control plane configuration.
        $ref: '#/definitions/OnPremControlPlaneConfiguration'
    x-form-factors: public
  RotateAgentCredentialsRequest:
    type: object
    description: Request object for the RotateAgentCredentialsRequest method.
    required:
      - pvc
    properties:
      pvc:
        type: string
        description: The account ID or CRN of the Private Cloud control plane.
    x-form-factors: public
  RotateAgentCredentialsResponse:
    type: object
    description: Response object for the RotateAgentCredentialsResponse method.
    x-form-factors: public
  UpdateOnPremControlPlaneRequest:
    type: object
    description: Request object for the UpdateOnPremControlPlane method.
    required:
      - pvc
      - samlIdentityProvider
    properties:
      pvc:
        type: string
        description: The account ID or CRN of the Private Cloud control plane.
      samlIdentityProvider:
        type: string
        description: The name or ID or CRN of the SAML identity provider from Public Cloud control plane in which users are allowed to operate on the Private Cloud control plane. The same or equivalent SAML IDP should be used by the Public Cloud control plane and the Private Cloud control plane, in order for the user to be mapped by SAML user ID.
      description:
        type: string
        maxLength: 1000
        description: The description of the Private Cloud control plane.
    x-form-factors: public
  UpdateOnPremControlPlaneResponse:
    type: object
    description: Response object for the UpdateOnPremControlPlane method.
    x-form-factors: public
  ListOnPremControlPlanesRequest:
    type: object
    description: Request object for the ListOnPremControlPlanesRequest method.
    properties:
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      pageToken:
        type: string
        x-paging-input-token: true
        description: A token to specify where to start paginating. This is the nextToken from a previously truncated response.
    x-form-factors: public
  ListOnPremControlPlanesResponse:
    type: object
    description: Response object for the ListOnPremControlPlanesResponse method.
    properties:
      controlPlaneConfigurations:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/OnPremControlPlaneConfiguration'
        description: The Private Cloud control plane configurations.
      nextPageToken:
        type: string
        x-paging-output-token: true
        description: The token to use when requesting the next set of results. If not present, there are no additional results.
    x-form-factors: public
  TestOnPremControlPlaneConnectivityRequest:
    type: object
    description: Request object for the TestOnPremControlPlaneConnectivity method.
    required:
      - pvc
    properties:
      pvc:
        type: string
        description: The account ID or CRN of the Private Cloud control plane.
    x-form-factors: public
  TestOnPremControlPlaneConnectivityResponse:
    type: object
    description: Response object for the TestOnPremControlPlaneConnectivity method.
    x-form-factors: public
  OnPremControlPlaneConfiguration:
    type: object
    description: Private Cloud control plane configuration.
    properties:
      pvcId:
        type: string
        description: The account ID of the Private Cloud control plane.
      pvcCrn:
        type: string
        description: The CRN of the Private Cloud control plane.
      type:
        description: The type for the Private Cloud control plane, this is always be CDP_PVC.
        $ref: '#/definitions/ControlPlaneType'
      name:
        type: string
        description: The name of the Private Cloud control plane.
      description:
        type: string
        description: The description of the Private Cloud control plane.
      baseUrl:
        type: string
        description: The base URL of the Private Cloud control plane.
      idpCrn:
        type: string
        description: The IDP CRN of the user.
      pvcStatus:
        type: string
        description: The status of the Private Cloud control plane.
      pvcEnvironmentCount:
        type: integer
        format: int32
        description: The total number of environments in the Private Cloud control plane.
      lastUpdatedTime:
        type: string
        format: date-time
        description: The date/time for the last updated time.
      agentSecretRotationStatus:
        type: string
        description: The status of the Jumpgate Agent Secret Rotation in the Private Cloud control plane.
    x-form-factors: public,private
  ControlPlaneType:
    type: string
    description: "The type of a remote cluster.\n `CDP_PVC` - CDP Private Cloud control plane."
    enum:
      - CDP_PVC
    x-form-factors: public,private
x-audit: true
