x-generated: Automatically generated by CDP protoc plugin. Do not edit manually. swagger: '2.0' x-endpoint-name: compute x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: version: 0.9.163 title: Cloudera Compute Service license: name: Apache 2.0 description: Defining service of compute public API service termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html schemes: - https consumes: - application/json produces: - application/json paths: /api/v1/compute/createCluster: post: summary: Create compute cluster description: Creates compute cluster. operationId: createCluster x-form-factors: public parameters: - name: input in: body required: true schema: $ref: '#/definitions/CreateClusterRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/CreateClusterResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' x-mutating: true /api/v1/compute/deleteCluster: post: summary: Delete compute cluster description: Deletes compute cluster. operationId: deleteCluster x-form-factors: public 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/compute/describeCluster: post: summary: Describe compute cluster description: Describe compute cluster details in a CDP Environment operationId: describeCluster 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/compute/describeDeployment: post: summary: Describes a deployment description: Gets a single deployment along with its extended history. This can also include all of the known templates. operationId: describeDeployment parameters: - name: input in: body required: true schema: $ref: '#/definitions/DescribeDeploymentRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/DescribeDeploymentResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' x-mutating: false /api/v1/compute/getOperationDetails: post: summary: GetOperationDetails description: To get detailed information about the long running operation. operationId: getOperationDetails x-entitlement: COMPUTE_API_LIFTIE x-form-factors: public parameters: - name: input in: body required: true schema: $ref: '#/definitions/GetOperationDetailsRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/GetOperationDetailsResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' x-mutating: false /api/v1/compute/getOperationStatus: post: summary: GetOperationStatus description: A lightweight API to get status of a long running operation. operationId: getOperationStatus x-entitlement: COMPUTE_API_LIFTIE x-form-factors: public parameters: - name: input in: body required: true schema: $ref: '#/definitions/GetOperationStatusRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/GetOperationStatusResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' x-mutating: false /api/v1/compute/listClusters: post: summary: List compute clusters description: List all compute clusters in a CDP Environment operationId: listClusters x-paging-default-max-items: 100 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/compute/listDeployments: post: summary: List deployments in the cluster. description: Lists the helm charts that are available for deployment or have already been deployed in this cluster. operationId: listDeployments parameters: - name: input in: body required: true schema: $ref: '#/definitions/ListDeploymentsRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/ListDeploymentsResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' x-mutating: false /api/v1/compute/resumeCluster: post: summary: Resume Cluster description: Resumes the compute cluster operationId: resumeCluster x-form-factors: public parameters: - name: input in: body required: true schema: $ref: '#/definitions/ResumeClusterRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/ResumeClusterResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' x-mutating: true /api/v1/compute/retryOperation: post: summary: ResetOperation description: To reset a failed operation for retry. operationId: retryOperation x-entitlement: COMPUTE_API_LIFTIE x-form-factors: public parameters: - name: input in: body required: true schema: $ref: '#/definitions/RetryOperationRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/RetryOperationResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' x-mutating: true /api/v1/compute/suspendCluster: post: summary: Suspend Cluster description: Suspends the compute cluster operationId: suspendCluster x-form-factors: public parameters: - name: input in: body required: true schema: $ref: '#/definitions/SuspendClusterRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/SuspendClusterResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' x-mutating: true /api/v1/compute/updateCluster: post: summary: Update cluster description: Updates compute cluster. operationId: updateCluster x-entitlement: COMPUTE_API_LIFTIE x-form-factors: public 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/compute/upgradeCluster: post: summary: Upgrade kubernetes version of the cluster description: Upgrades the kubernetes version of the cluster to the specified version. operationId: upgradeCluster x-entitlement: COMPUTE_API_LIFTIE x-form-factors: public parameters: - name: input in: body required: true schema: $ref: '#/definitions/UpgradeClusterRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/UpgradeClusterResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' x-mutating: true /api/v1/compute/upgradeDeployment: post: summary: Upgrades a deployment to a different chart. description: Upgrades a deployment to a different chart. operationId: upgradeDeployment parameters: - name: input in: body required: true schema: $ref: '#/definitions/UpgradeDeploymentRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/UpgradeDeploymentResponse' default: description: The default response on an error. schema: $ref: '#/definitions/Error' x-mutating: true /api/v1/compute/validateCluster: post: summary: Validate compute cluster description: Validates compute cluster. operationId: validateCluster x-form-factors: public parameters: - name: input in: body required: true schema: $ref: '#/definitions/ValidateClusterRequest' responses: 200: description: Expected response to a valid request. schema: $ref: '#/definitions/ValidateClusterResponse' 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. EnvCloudProvider: type: string description: "Object representing cloud provider type for Cloudera environment.\n `AWS` - Cloudera environment installed in AWS. `AZURE` - Cloudera environment installed in Azure. `OPENSHIFT` - Cloudera environment installed as on-premises installation using OpenShift in the base cluster. `GCP` - Cloudera environment installed in GCP. `REDHAT` - Cloudera environment installed as an on-premises deployment using Red Hat infrastructure. `KCLOUD` - Cloudera environment installed as an on-premises deployment using KCLOUD infrastructure. `STANDARD` - Cloudera environment installed as a generic on-premises deployment using CDP Data services." enum: - AWS - AZURE - OPENSHIFT ComputePlatform: type: string description: "Object representing Cloudera Compute Cluster Platform provider.\n `OPENSHIFT` - OpenShift Container Platform cluster as compute platform (Cloudera on-premises only). `EKS` - EKS cluster as compute platform `AKS` - AKS cluster as compute platform `RKE` - Rancher RKE as compute platform (Cloudera on-premises only). `GKE` - GKE cluster as compute platform `OCP` - OCP Container Platform cluster as compute platform (Cloudera on-premises only). `KCLOUD` - KCLOUD cluster as compute platform (Cloudera on-premises only). `STANDARD` - STANDARD cluster as compute platform (Cloudera on-premises only)." enum: - OPENSHIFT - EKS - AKS - RKE ComputeClusterType: type: string description: "Object representing compute cluster types.\n `Shared` - Value representing a shared compute cluster. `DedicatedExternal` - Value representing an external dedicated compute cluster. `Dedicated` - Value representing an embedded dedicated compute cluster." enum: - Shared - DedicatedExternal - Dedicated DescribeClusterRequest: type: object description: Request object for describing a cluster. required: - clusterCrn properties: clusterCrn: type: string description: Compute cluster CRN. ComputeClusterOwner: type: object description: Compute cluster owner structure. properties: email: type: string description: Owner's email. firstName: type: string description: Owner's firstname. lastName: type: string description: Owner's lastname. userId: type: string description: Owner's user ID. accountId: type: string description: Owner's account ID. crn: type: string description: Owner's actor CRN. x-form-factors: public CommonApiServerResp: type: object description: API server response structure. properties: authorizedIpRanges: type: array items: type: string description: An array of IPv4 CIDR blocks. enabled: type: boolean description: Flag to indicate if whitelist of IP Ranges (CIDR block) for public access to the kubernetes API server is enabled. x-form-factors: public AzureSecretEncryptionResp: type: object description: Azure Secret Encryption response structure. properties: encryptionKeyUrl: type: string description: Encryption key URI. userManagedIdentity: type: string description: Resource ID of the user managed identity. x-form-factors: public CommonSecretEncryptionResp: type: object description: Secret Encryption response structure. properties: customerKmsKeyArn: type: string description: AWS KMS key ARN. azure: description: Azure secret encryption details. $ref: '#/definitions/AzureSecretEncryptionResp' x-form-factors: public AzureVolumeEncryptionResp: type: object description: Azure Volume Encryption response structure. properties: diskEncryptionSetId: type: string description: Disk encryption set ID. x-form-factors: public CommonVolumeEncryptionResp: type: object description: Volume encryption response structure. properties: customerKmsKeyArn: type: string description: AWS KMS key ARN. azure: description: Azure volume encryption details. $ref: '#/definitions/AzureVolumeEncryptionResp' x-form-factors: public CommonSecurityResp: type: object description: Security response structure. properties: apiServer: description: API server. $ref: '#/definitions/CommonApiServerResp' secretEncryption: description: Secret encryption. $ref: '#/definitions/CommonSecretEncryptionResp' volumeEncryption: description: Volume encryption. $ref: '#/definitions/CommonVolumeEncryptionResp' private: type: boolean description: Flag to indicate if this is a private cluster with API Server having internal IP addressees. x-form-factors: public CommonYuniKornResp: type: object description: YuniKorn response structure. properties: enabled: type: boolean description: Flag to indicate if yunikorn is enabled. version: type: string description: Version. Deprecated. x-deprecated: true appSortingPolicy: type: string description: The app sorting policy. Deprecated. x-deprecated: true nodeSortingPolicy: type: string description: The node sorting policy. Deprecated. x-deprecated: true x-form-factors: public CommonNvidiaResp: type: object description: Nvidia response structure. properties: gpuLabelKey: type: string description: GPU label key. gpuLabelValue: type: string description: GPU label value. x-form-factors: public CommonAlertmanagerResp: type: object description: Alertmanager response structure. properties: enabled: type: boolean description: Flag to indicate if Alertmanager is enabled. x-form-factors: public CommonResourceLimitsResp: type: object description: Resource limits response structure. properties: cpu: type: string description: Prometheus server CPU limit (default 1000m). memory: type: string description: Prometheus server memory limit (default 2048M). x-form-factors: public CommonMonitoringResp: type: object description: Monitoring response structure. properties: enabled: type: boolean description: Flag to indicate if Monitoring is enabled. alertmanager: description: Alertmanager. $ref: '#/definitions/CommonAlertmanagerResp' serverResourceLimits: description: Server resource limits. $ref: '#/definitions/CommonResourceLimitsResp' x-form-factors: public CommonMeteringServiceResp: type: object description: Metering service response structure. properties: serviceType: type: string description: Service type. serviceVersion: type: string description: Service version. workloadCrn: type: string description: Workload CRN. clusterCrn: type: string description: Cluster CRN. serviceConfiguration: type: string description: Service configuration. x-form-factors: public CommonMeteringResp: type: object description: Metering response structure. properties: enabled: type: boolean description: Flag to indicate if Monitoring is enabled. services: type: array items: $ref: '#/definitions/CommonMeteringServiceResp' description: Array of services. x-form-factors: public CommonLoggingResp: type: object description: Logging response structure. properties: enabled: type: boolean description: True to enable logging installation (default false). x-form-factors: public CommonDeploymentProfileDetailsResp: type: object description: Deployment Profile details response structure. properties: enabled: type: boolean description: Deployment enable flag. deploymentProfile: type: string description: Deployment profile used. Currently supported is common. x-form-factors: public CommonHorizontalPodAutoScalerResp: type: object description: Horizontal pod autoscaler response structure. properties: enabled: type: boolean description: Enable flag. x-form-factors: public CommonAutoscalerResp: type: object description: Autoscaler response structure. properties: scaleDownDelayAfterAdd: type: string description: How long after scale up that scale down evaluation resumes. (Azure/AWS Support). scaleDownDelayAfterDelete: type: string description: How long after node deletion that scale down evaluation resumes, defaults to scanInterval. (Azure/AWS Support). scaleDownDelayAfterFailure: type: string description: How long after scale down failure that scale down evaluation resumes. (Azure/AWS Support). scaleDownEnabled: type: boolean description: Scale down flag. (AWS Support). scaleDownNonEmptyCandidatesCount: type: integer format: int32 description: Maximum number of non empty nodes considered in one iteration as candidates for scale down with drain. Lower value means better CA responsiveness but possible slower scale down latency. Higher value can affect CA performance with big clusters (100s of nodes). Set to non positive value to turn this heuristic off - CA will not limit the number of nodes it considers. (AWS Support). scaleDownUnneededTime: type: string description: How long a node should be unneeded before it is eligible for scale down. (Azure/AWS Support). scaleDownUtilizationThreshold: type: number format: double description: Node utilization level, defined as the sum of requested resources divided by capacity,. below which a node can be considered for scale down. (Azure/AWS Support). scanInterval: type: string description: Scan interval. (Azure/AWS Support). skipNodesWithLocalStorage: type: boolean description: Skip nodes with local storage flag. (AWS Support). skipNodesWithSystemPods: type: boolean description: Skip nodes with system pods. (AWS Support). maxGracefulTerminationSec: type: integer format: int64 description: Maximum number of seconds CA waits for pod termination when trying to scale down a node. (Azure Support). scaleDownUnreadyTime: type: string description: How long an unready node should be unneeded before it is eligible for scale down. (Azure Support). x-form-factors: public CommonDeploymentsResp: type: object description: Deployments response structure. properties: autoscaler: description: Autoscaler specs. $ref: '#/definitions/CommonAutoscalerResp' horizontalPodAutoscaler: description: Horizontal pod autoscaler specs. $ref: '#/definitions/CommonHorizontalPodAutoScalerResp' istio: description: Istio specs. $ref: '#/definitions/CommonDeploymentProfileDetailsResp' logging: description: Logging specs. $ref: '#/definitions/CommonLoggingResp' metering: description: Metering specs. $ref: '#/definitions/CommonMeteringResp' monitoring: description: Monitoring specs. $ref: '#/definitions/CommonMonitoringResp' nvidia: description: Nvidia specs. $ref: '#/definitions/CommonNvidiaResp' repository: type: string description: Repository for images. yunikorn: description: Yunikorn specs. $ref: '#/definitions/CommonYuniKornResp' telemetryKmsKeyArn: type: string description: Telemetry KMS key ARN. knox: description: Knox specs. $ref: '#/definitions/CommonDeploymentProfileDetailsResp' x-form-factors: public CommonInstanceStateCounts: type: object description: Instance state counts response structure. properties: running: type: integer format: int64 description: Number of instances in running state. creating: type: integer format: int64 description: Number of instances in creating state. terminating: type: integer format: int64 description: Number of instances in terminating state. total: type: integer format: int64 description: Total number of instances. x-form-factors: public AksPoolInstance: type: object description: AKS pool instance response structure. properties: name: type: string description: Name. instanceId: type: string description: Instance ID. availabilityZone: type: string description: Availability zone. subnetId: type: string description: Subnet ID. x-form-factors: public AksNodePool: type: object description: AKS node pool response structure. properties: name: type: string description: Name. type: type: string description: Type. provisioningState: type: string description: Provisioning state. instances: type: array items: $ref: '#/definitions/AksPoolInstance' description: AKS pool instance. availabilityZones: type: array items: type: string description: Availability zones. x-form-factors: public AksInstanceGroup: type: object description: AKS instance group response structure. properties: instanceGroupName: type: string description: Instance group name. instanceGroupId: type: string description: Instance group ID. instanceType: type: string description: Instance type. instanceTier: type: string description: Instance tier. instanceStates: description: Instance states $ref: '#/definitions/CommonInstanceStateCounts' instanceCount: type: integer format: int64 description: Instance count. nodeVolumeSize: type: integer format: int64 description: Node volume size. enableAutoScaling: type: boolean description: Enable auto scaling. minInstance: type: integer format: int64 description: Min instances. maxInstance: type: integer format: int64 description: Max instances. singleZone: type: boolean description: Single zone. labels: type: object description: Labels. additionalProperties: type: string taints: type: object description: Taints. additionalProperties: type: string tags: type: object description: Tags. additionalProperties: type: string kubeReservedCpu: type: integer format: int64 description: Kube reserved CPU. kubeReservedMemory: type: integer format: int64 description: Kube reserved memory. kubeReservedStorage: type: integer format: int64 description: Kube reserved storage. systemReservedCpu: type: integer format: int64 description: System reserved CPU. systemReservedMemory: type: integer format: int64 description: System reserved memory. systemReservedStorage: type: integer format: int64 description: System reserved storage. availabilityZones: type: array items: type: integer format: int32 description: Availability zones. nodePool: description: AKS node pool. $ref: '#/definitions/AksNodePool' instances: type: array items: $ref: '#/definitions/AksPoolInstance' description: AKS pool instance. isSystem: type: boolean description: True for a system node. x-form-factors: public AksState: type: object description: AKS state response structure. properties: provider: type: string description: Cloud provider. clusterDisplayName: type: string description: Cluster display name. clusterResourceGroup: type: string description: The Cluster ResourceGroup. Filled based on Parent ResourceGroup or ClusterDisplayName. clusterResourceGroupCreated: type: boolean description: Specifies whether ClusterResourceGroup was created or not. enableHttpApplicationRouting: type: boolean description: Specifies whether httpApplicationRouting addon is enabled or not. enableMonitoring: type: boolean description: Specifies whether monitoring addon is enabled or not. logAnalyticsWorkspaceResourceGroup: type: string description: The resource group for the Azure Log Analytics Workspace. logAnalyticsWorkspace: type: string description: An existing Azure Log Analytics Workspace for monitoring addon. virtualNetworkResourceGroup: type: string description: The resource group for the Azure Virtual Network. Composite of agent virtual network subnet ID. virtualNetwork: type: string description: An existing Azure Virtual Network. Composite of agent virtual network subnet ID. subnets: type: array items: type: string description: An array specifying existing Azure Virtual Subnets. Composite of agent virtual network subnet IDs. selectedSubnet: type: string description: Selected Subnet from the list that is provided parentResourceGroup: type: string description: The ResourceGroup which may be used for almost all the Azure resources created (with VirtualNetwork and Node ResourceGroup being exceptions). adminUsername: type: string description: The username to use for Linux VMs. sshPublicKeyContents: type: string description: The content of the SSH configuration for Linux VMs, Opposite to sshPublicKey. sshPublicKey: type: string description: The local path of the SSH configuration for Linux VMs, Opposite to sshPublicKeyContents. dnsServiceIp: type: string description: An IP address assigned to the kubernetes DNS service, it must be within the kubernetes service address range specified in serviceCidr. dockerBridgeCidr: type: string description: A CIDR notation IP range assigned to the Docker bridge network, it must not overlap with any Azure Subnet IP ranges or the kubernetes service address range. networkPlugin: type: string description: The plugin used for kubernetes network. networkPolicy: type: string description: The policy used for kubernetes network. podCidr: type: string description: A CIDR notation IP range from which to assign pod IPs when networkPlugin is using kubenet. serviceCidr: type: string description: A CIDR notation IP range from which to assign service cluster IPs, it must not overlap with any Azure Subnet IP ranges. networkCidrs: type: array items: type: string description: The actual CIDR ranges of the virtual network. workerIngressRules: type: array items: type: string description: Ingress rules for worker nodes. workerEgressRules: type: array items: type: string description: Egress rules for worker nodes. masterDnsPrefix: type: string description: DNS prefix used for hostnames in the cluster. tags: type: object description: Tags. additionalProperties: type: string instanceGroups: type: object description: Instance groups. additionalProperties: $ref: '#/definitions/AksInstanceGroup' deployments: description: Deployments. $ref: '#/definitions/CommonDeploymentsResp' userData: type: string description: User data. security: description: Security. $ref: '#/definitions/CommonSecurityResp' egressType: type: string description: EgressType specifies the outbound type used by the cluster. aksManagedIdentity: type: string description: AksManagedIdentity is the user-assigned managed identity to be used by the AKS control plane. privateDnsZone: type: string description: PrivateDNSZone for the AKS cluster. oidcIssuerURL: type: string description: URL of the OIDCIssuer attached to the cluster. x-form-factors: public CommonEvent: type: object description: Event response structure. properties: details: type: string description: Details. name: type: string description: Event name. progress: type: string description: Progress. resourceType: type: string description: Resource type. status: type: string description: Status. statusReason: type: string description: Status reason. timestamp: type: string description: Timestamp. x-form-factors: public EksInstance: type: object description: EKS instance response structure. properties: instanceId: type: string description: Instance ID. availabilityZone: type: string description: Availability zone. subnetId: type: string description: Subnet ID. x-form-factors: public AcceleratorConfigResp: type: object description: Accelerator Configurations structure properties: acceleratorManufacturers: type: array items: type: string description: Accelerator Manufacturer type. For eg. amazon-web-service, AMD, nvidia. acceleratorTypes: type: array items: type: string description: Accelerator Types. For eg. gpu, inference. x-form-factors: public CommonInstanceRequirementsResp: type: object description: Instance requirements structure. properties: allowedInstanceTypes: type: array items: type: string description: Instance types to include. cpuTypes: type: array items: type: string description: CPU types required. For eg. intel, amd, amazon-web-services etc. excludedInstanceTypes: type: array items: type: string description: Instance types to exclude, ignored if AllowedInstanceTypes is set. maxCpu: type: integer format: int64 description: Maximum vCpu count. minCpu: type: integer format: int64 description: Minimum vCpu count. maxMemory: type: integer format: int64 description: Maximum memory requirement in MiB. minMemory: type: integer format: int64 description: Minimum memory requirement in MiB. acceleratorConfig: description: Accelerator Config for AWS. $ref: '#/definitions/AcceleratorConfigResp' x-form-factors: public CommonInstanceRequirementsWithMetadataResp: type: object description: Instance requirements with metadata response structure. properties: architectureTypes: type: array items: type: string description: The architecture types. For eg, i386, x86_64, arm64, x86_64_mac, arm64_mac. virtualizationTypes: type: array items: type: string description: The virtualization types. For eg. hvm, paravirtual. instanceRequirements: description: The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. $ref: '#/definitions/CommonInstanceRequirementsResp' x-form-factors: public EksInstanceGroup: type: object description: EKS instance group response structure. properties: ami: type: string description: AMI. imageParam: type: string description: Image param. instanceGroupName: type: string description: Instance group name. instanceGroupId: type: string description: Instance group ID. instanceTier: type: string description: Instance tier. instanceTypes: type: array items: type: string description: Instance types. instanceCount: type: integer format: int64 description: Instance count. instanceStates: description: Instance states $ref: '#/definitions/CommonInstanceStateCounts' singleZone: type: boolean description: Single zone. minInstance: type: integer format: int64 description: Min instances. maxInstance: type: integer format: int64 description: Max instances. nodeInstanceRole: type: string description: Node instance role. nodeVolumeSize: type: integer format: int64 description: Node volume size. labels: type: object description: Labels. additionalProperties: type: string taints: type: object description: Taints. additionalProperties: type: string tags: type: object description: Tags. additionalProperties: type: string autoscalingEnabled: type: boolean description: Autoscaling enabled. kubeReservedCpu: type: integer format: int64 description: Kube reserved CPU. kubeReservedMemory: type: integer format: int64 description: Kube reserved memory. kubeReservedStorage: type: integer format: int64 description: Kube reserved storage. systemReservedCpu: type: integer format: int64 description: System reserved CPU. systemReservedMemory: type: integer format: int64 description: System reserved memory. systemReservedStorage: type: integer format: int64 description: System reserved storage. enableCfsQuota: type: boolean description: Enable cfs quota. instances: type: array items: $ref: '#/definitions/EksInstance' description: EKS Instance. events: type: array items: $ref: '#/definitions/CommonEvent' description: Events. instanceGroupStatus: type: string description: Instance group status. lTNameSuffix: type: string description: Launch Template name suffix. instanceRequirementswithMetadata: description: Instance requirements. $ref: '#/definitions/CommonInstanceRequirementsWithMetadataResp' instanceProfile: type: string description: Instance profile name. imdsVersions: type: array items: type: string description: IMDS versions. x-form-factors: public EksState: type: object description: EKS state response structure. properties: provider: type: string description: Provider. clusterDisplayName: type: string description: Cluster display name. userData: type: string description: User data for this cluster. virtualNetwork: type: string description: Virtual network details. existingVirtualNetwork: type: boolean description: Existing virtual network if used. subnets: type: array items: type: string description: Subnets. workerSubnets: type: array items: type: string description: Worker subnets. securityGroups: type: array items: type: string description: Security groups. serviceRole: type: string description: Service role. workerInstanceProfile: type: string description: Worker instance profile. associateWorkerNodePublicIp: type: boolean description: Associate worker node public IP. vpcCidr: type: string description: VPC CIDR. workerIngressRules: type: array items: type: string description: Ingress rules for worker nodes. workerEgressRules: type: array items: type: string description: Egress rules for worker nodes. workerSecurityGroup: type: string description: Worker security group. telemetryEnabled: type: boolean description: Telemetry enabled. telemetryLoggingEnabled: type: boolean description: Telemetry logging enabled. telemetryLoggingStorageLocation: type: string description: Telemetry logging storage location. telemetryLoggingBucket: type: string description: Telemetry logging bucket. telemetryLoggingRootDir: type: string description: Telemetry logging root dir. telemetryKmsKeyArn: type: string description: Telemetry logging root dir. tags: type: object description: Tags. additionalProperties: type: string sshKeyPairName: type: string description: SSH key pair name. kmsKeyArn: type: string description: KMS key ARN. instanceGroups: type: object description: Instance groups. additionalProperties: $ref: '#/definitions/EksInstanceGroup' deployments: description: Deployments. $ref: '#/definitions/CommonDeploymentsResp' sshPublicKey: type: string description: SSH public key. networkPlugin: type: string description: Network plugin. serviceCidr: type: string description: Service CIDR. inboundProxyCidrs: type: array items: type: string description: Array of inbound proxy CIDRs. security: description: Security. $ref: '#/definitions/CommonSecurityResp' suspendedProcesses: type: array items: type: string description: Suspended processes. csiEnabled: type: boolean description: Whether CSI is enabled. x-form-factors: public CommonImageCatalogResp: type: object description: Image catalog response structure. properties: crn: type: string description: The catalog CRN (either CRN or name is required). name: type: string description: The catalog name (either CRN or name is required). x-form-factors: public CommonStorageSpecResp: type: object description: Storage spec response structure. properties: csiEnabled: type: boolean description: Flag to enable CSI (Container Storage Interface). It further sets specific inline cloud formation policies required for CSI. x-form-factors: public CommonNodeImageAvailableUpgrade: type: object description: Structure to list the currently used images and the new upgrades available. properties: instanceGroup: type: string description: Instance group name. current: type: string description: Currently used node image version. upgrades: type: array items: type: string description: Available node image upgrade versions. x-form-factors: public DescribeClusterResponse: type: object description: Describe cluster response. properties: envName: type: string description: CDP environment name. envCloudProvider: description: CDP environment cloud provider. $ref: '#/definitions/EnvCloudProvider' clusterName: type: string description: Compute cluster name. clusterCrn: type: string description: Compute cluster CRN. description: type: string description: Description about the cluster. x-form-factors: private status: type: string description: Compute cluster status. computePlatform: description: Compute cluster platform provider. $ref: '#/definitions/ComputePlatform' computePlatformVersion: type: string description: Compute cluster platform version. x-form-factors: private kubernetesVersion: type: string description: Kubernetes version. clusterSize: type: integer format: int32 description: Number of nodes in the cluster. x-form-factors: private dashboardUrl: type: string description: Compute cluster platform dashboard url. isClouderaManaged: type: boolean description: Is compute cluster cloudera managed or not. x-form-factors: private clusterType: description: Compute cluster type. $ref: '#/definitions/ComputeClusterType' creationTime: type: string description: Compute cluster creation time in ISO format. clusterId: type: string description: Compute cluster ID. envCrn: type: string description: CDP environment CRN. apiEndPoint: type: string description: API endpoint. x-form-factors: public clusterStateVersion: type: integer format: int32 description: Cluster state version. x-form-factors: public deletionTime: type: string description: Compute cluster deletion time in ISO format. x-form-factors: public updateTime: type: string description: Compute cluster update time in ISO format. x-form-factors: public workloads: type: array items: type: string description: Workloads. x-form-factors: public clusterOwner: description: Cluster owner. $ref: '#/definitions/ComputeClusterOwner' x-form-factors: public region: type: string description: Region. x-form-factors: public message: type: string description: Message with additional details about the cluster status. x-form-factors: public account: type: string description: CDP account ID. x-form-factors: public availableUpgrades: type: array items: type: string description: List of available kubernetes upgrades. x-form-factors: public imageCatalog: description: The image catalog details. $ref: '#/definitions/CommonImageCatalogResp' x-form-factors: public storage: description: The storage specifications. $ref: '#/definitions/CommonStorageSpecResp' x-form-factors: public labels: type: object description: Map of labels associated with this cluster. additionalProperties: type: string bootstrapScript: type: string description: Bootstrap script used to setup this cluster. aks: description: AKS state. $ref: '#/definitions/AksState' x-form-factors: public eks: description: EKS state. $ref: '#/definitions/EksState' x-form-factors: public nodeImageUpgradeAvailable: type: boolean description: Is a node image upgrade available. x-form-factors: public nodeImageUpgrades: type: array items: $ref: '#/definitions/CommonNodeImageAvailableUpgrade' description: Lists the currently used images and the new upgrades available. x-form-factors: public isDefault: type: boolean description: The cluster which is automatically created for every containerized environment. x-form-factors: public clusterShape: type: string description: The clusterShape represents the shape of the cluster, which can be "Embedded" or "Externalized". x-form-factors: public ListClustersRequest: type: object description: Request object to list clusters. properties: envNameOrCrn: type: string description: Environment name or crn. workloads: type: string description: Workloads for workload filtering. x-form-factors: public status: type: string description: Cluster Status for status filtering. x-form-factors: public pageSize: type: integer format: int32 minimum: 1 maximum: 500 x-paging-page-size: true description: The size of each page. Default is 100. default: 100 x-form-factors: public startingToken: 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. 1 or empty for first page. x-form-factors: public includeDeleted: type: boolean description: Include deleted clusters in the response. x-form-factors: public default: type: boolean description: Only show default clusters. clusterShape: type: string description: Filter between Externalized and Embedded cluster shapes. ListClusterItem: type: object description: List clusters item structure. properties: envName: type: string description: CDP environment name. envCloudProvider: description: CDP environment cloud provider. $ref: '#/definitions/EnvCloudProvider' clusterName: type: string description: Compute cluster name. clusterCrn: type: string description: Compute cluster CRN. status: type: string description: Compute cluster status. computePlatform: description: Compute cluster platform provider. $ref: '#/definitions/ComputePlatform' computePlatformVersion: type: string description: Compute cluster platform version. x-form-factors: private kubernetesVersion: type: string description: Kubernetes version. clusterSize: type: integer format: int32 description: Number of nodes in the cluster. x-form-factors: private clusterId: type: string description: Compute cluster ID. envCrn: type: string description: CDP environment CRN. clusterType: description: Compute cluster type. $ref: '#/definitions/ComputeClusterType' x-form-factors: public creationTime: type: string description: Compute cluster creation time in ISO format. x-form-factors: public deletionTime: type: string description: Compute cluster deletion time in ISO format. x-form-factors: public updateTime: type: string description: Compute cluster update time in ISO format. x-form-factors: public clusterStateVersion: type: integer format: int32 description: Cluster state version. x-form-factors: public clusterOwner: description: Cluster owner. $ref: '#/definitions/ComputeClusterOwner' x-form-factors: public region: type: string description: Region. x-form-factors: public message: type: string description: Message with additional details about the cluster status. x-form-factors: public account: type: string description: / CDP account ID. x-form-factors: public availableUpgrades: type: array items: type: string description: List of available kubernetes upgrades. x-form-factors: public imageCatalog: description: The image catalog details. $ref: '#/definitions/CommonImageCatalogResp' x-form-factors: public storage: description: The storage specifications. $ref: '#/definitions/CommonStorageSpecResp' x-form-factors: public labels: type: object description: Map of labels associated with this cluster. additionalProperties: type: string isDefault: type: boolean description: The cluster which is automatically created for every containerized environment. x-form-factors: public clusterShape: type: string description: The clusterShape represents the shape of the cluster, which can be "Embedded" or "Externalized". x-form-factors: public ListClustersResponse: type: object description: List clusters response. properties: clusters: type: array x-paging-result: true items: $ref: '#/definitions/ListClusterItem' description: Array of CDP compute clusters. nextToken: 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 totalClusters: type: integer format: int32 description: Total number of clusters. x-form-factors: public totalPages: type: integer format: int32 description: Total number of pages. x-form-factors: public UpdateClusterRequest: type: object description: Update compute cluster request. required: - clusterCrn - spec - clusterStateVersion properties: clusterCrn: type: string description: Compute Cluster CRN. spec: description: Spec for updating compute cluster. $ref: '#/definitions/CommonUpdateClusterSpec' clusterStateVersion: type: integer format: int64 description: Current cluster state version of the compute cluster being updated. UpdateClusterResponse: type: object description: Update compute cluster response. properties: clusterCrn: type: string description: Compute cluster CRN. clusterStatus: description: Status of the compute cluster. $ref: '#/definitions/CommonStatusMessage' uri: type: string description: Uniform resource identifier of the compute cluster. validationResponse: description: Pre-flight validation check response. Only given on a validation failure and `skipValidation` is false. $ref: '#/definitions/ValidationResponse' x-form-factors: public CommonUpdateClusterSpec: type: object description: Compute cluster update spec. properties: refreshInstanceGroups: type: boolean description: Whether to refresh nodes of instance groups belonging to the compute cluster. CommonNetwork: type: object description: Network structure. properties: subnets: type: array items: type: string description: Subnets. podCidr: type: string description: The pod CIDR to use if the backend provider supports setting this. serviceCidr: type: string description: The CIDR for services declared inside of Kubernetes if the backend provider supports setting this. outboundType: type: string description: Cluster outbound type. Currently supported is udr. x-form-factors: public CommonStatusMessage: type: object description: Cluster status structure. properties: message: type: string description: Message. status: type: string description: Status. CreateClusterRequest: type: object description: Request object for creating a cluster. required: - environment - name properties: environment: type: string description: Environment CRN. Required. name: type: string description: Cluster name. Required. description: type: string description: Cluster description. tags: type: object description: Cluster level tags. additionalProperties: type: string network: description: Network. $ref: '#/definitions/CommonNetwork' skipValidation: type: boolean description: Skip validation. x-form-factors: public ValidateClusterRequest: type: object description: Request object for validating a cluster. required: - environment - name properties: environment: type: string description: Environment CRN. Required. name: type: string description: Cluster name. Required. description: type: string description: Cluster description. tags: type: object description: Cluster level tags. additionalProperties: type: string network: description: Network. $ref: '#/definitions/CommonNetwork' x-form-factors: public ValidationSummary: type: object description: Validation summary structure. properties: passed: type: integer format: int32 description: Total number of passed validations. warning: type: integer format: int32 description: Total number of validations that passed but have warnings associated with them. failed: type: integer format: int32 description: Total number of failed validations. skipped: type: integer format: int32 description: Total number of skipped validations. total: type: integer format: int32 description: Total number of validations. x-form-factors: public ValidationResult: type: object description: Validation result structure. properties: name: type: string description: Name. description: type: string description: Description. category: type: string description: Validation check categories such as COMMON, ENTITLEMENTS, CONTROL_PLANE, NETWORK, or DEPLOYMENT. New values may be added in the future. status: type: string description: Validation check status such as PASSED, FAILED, or SKIPPED. New values may be added in the future. message: type: string description: A short, human-readable message that describes the end result of the validation. detailedMessage: type: string description: A supporting message which contains additional details, such as subnet names, instance types, etc. duration: type: string description: Time taken to get the end result of the validation in a human-readable time format. x-form-factors: public ValidationResponse: type: object description: Pre-flight validation check response structure. properties: result: type: string description: Validation result. summary: description: Numerical summary of the validations. $ref: '#/definitions/ValidationSummary' message: type: string description: A message describing end result of the validations. validations: type: array items: $ref: '#/definitions/ValidationResult' description: The list of detailed validation result. x-form-factors: public CreateClusterResponse: type: object description: Create cluster response. properties: clusterId: type: string description: Compute cluster ID. clusterStatus: description: Cluster status. $ref: '#/definitions/CommonStatusMessage' uri: type: string description: Uniform Resource Identifier of cluster. clusterCrn: type: string description: Compute cluster CRN. validationResponse: description: Pre-flight validation check response. Only given on a validation failure. $ref: '#/definitions/ValidationResponse' x-form-factors: public ValidateClusterResponse: type: object description: Validate cluster response. properties: result: type: string description: Validation result. summary: description: Numerical summary of the validations. $ref: '#/definitions/ValidationSummary' message: type: string description: A message describing the end result of the validations. validations: type: array items: $ref: '#/definitions/ValidationResult' description: The list of detailed validation results. x-form-factors: public DeleteClusterRequest: type: object description: Request object for deleting a cluster. required: - clusterCrn properties: clusterCrn: type: string description: Compute cluster CRN. force: type: boolean description: Forces the cluster into the DELETED state without cleaning up resources; only valid if cluster is in DELETE_FAILED state. skipWorkloadsValidation: type: boolean description: Whether to skip the running workloads validation for externalized clusters skipValidation: type: boolean description: Whether to skip validation. x-form-factors: public DeleteClusterResponse: type: object description: Delete cluster response. properties: clusterStatus: description: Cluster Status. $ref: '#/definitions/CommonStatusMessage' validationResponse: description: Pre-flight validation check response. Only given on a validation failure. $ref: '#/definitions/ValidationResponse' x-form-factors: public DescribeDeploymentRequest: type: object description: Request structure for describing a deployment. required: - clusterCrn - namespace - name properties: clusterCrn: type: string description: Compute cluster CRN. namespace: type: string description: The namespace of the deployment. name: type: string description: The name of the deployment. Chart: type: object description: Chart structure. properties: applicationVersion: type: string description: The version (usually of the images) of the components being deployed. deploymentVersion: type: string description: The version of this chart (which is not the version of the components being deployed). description: type: string description: The chart description. name: type: string description: The chart name. values: type: string description: Escaped JSON for values.yaml of that chart. AvailableDeploymentUpgrade: type: object description: Available deployment upgrade structure. properties: applicationVersion: type: string description: The version of the components which would be installed from this deployment. deploymentVersion: type: string description: The version of the deployment that is available to upgrade to. Deployment: type: object description: Deployment structure. properties: name: type: string description: The name of the deployment. namespace: type: string description: The namespace of the deployment. revision: type: integer format: int32 description: Helm revision. liftieManaged: type: boolean description: True if Liftie is managing this deployment. chart: description: Chart that the deployment was created from. $ref: '#/definitions/Chart' status: type: string description: Status of the deployment. Currently supported values are UNKNOWN, DEPLOYED, UNINSTALLED, SUPERSEDED, FAILED, PENDING-INSTALL, PENDING-UPGRADE and PENDING-ROLLBACK. New values may be added in the future. upgrades: type: array items: $ref: '#/definitions/AvailableDeploymentUpgrade' description: Any upgrades available for this deployment. overrides: type: string description: Escaped JSON overrides for the deployment's properties. History: type: object description: History structure. properties: revision: type: integer format: int32 description: Helm revision. status: type: string description: Status of the deployment. Currently supported values are UNKNOWN, DEPLOYED, UNINSTALLED, SUPERSEDED, FAILED, PENDING-INSTALL, PENDING-UPGRADE and PENDING-ROLLBACK. New values may be added in the future. chart: description: Chart that the deployment was created from. $ref: '#/definitions/Chart' overrides: type: string description: Escaped JSON overrides for the deployment's properties for given revision. DescribeDeploymentResponse: type: object description: Response structure for describing a deployment. properties: deployment: description: Deployment details. $ref: '#/definitions/Deployment' history: type: array items: $ref: '#/definitions/History' description: History of the deployment. overrides: type: string description: Escaped JSON overrides for the deployment's properties. Deprecated. x-deprecated: true UpgradeDeploymentRequest: type: object description: Request structure for upgrading a deployment. required: - clusterCrn - namespace - name properties: clusterCrn: type: string description: Compute cluster CRN. namespace: type: string description: The namespace of the deployment. name: type: string description: The name of the deployment. chartVersion: type: string description: The version of the deployment to upgrade to. Defaults to latest version. overrides: type: string description: Escaped JSON overrides for the deployment's properties. UpgradeDeploymentResponse: type: object description: Response structure for upgrading a deployment. properties: name: type: string description: The name of the deployment. namespace: type: string description: The namespace of the deployment. revision: type: integer format: int32 description: Helm revision. message: type: string description: A message returned about the status of the upgrade operation. status: type: string description: Status of the deployment. Currently supported values are UNKNOWN, DEPLOYED, UNINSTALLED, SUPERSEDED, FAILED, PENDING-INSTALL, PENDING-UPGRADE and PENDING-ROLLBACK. New values may be added in the future. chart: description: Chart that the deployment was created from. $ref: '#/definitions/Chart' ListDeploymentsRequest: type: object description: Request structure to list deployments in the cluster. required: - clusterCrn properties: clusterCrn: type: string description: Compute cluster CRN. namespace: type: string description: The namespace of the deployment. Lists deployments in all namespaces if not specified. verbose: type: boolean description: Set true to get detailed chart response. Default is false. ListDeploymentsResponse: type: object description: Response structure to list deployments in the cluster. properties: availableCharts: type: array items: $ref: '#/definitions/Chart' description: Array of available charts. unavailableCharts: type: array items: $ref: '#/definitions/Chart' description: Array of unavailable charts. installedDeployments: type: array items: $ref: '#/definitions/Deployment' description: Array of installed deployments. SuspendClusterRequest: type: object description: Request structure to suspend the compute cluster required: - clusterCrn properties: clusterCrn: type: string description: Compute cluster CRN. skipWorkloadsValidation: type: boolean description: Whether to skip the running workloads validation for externalized clusters skipValidation: type: boolean description: Whether to skip validation. x-form-factors: public SuspendClusterResponse: type: object description: Response structure for suspending the compute cluster properties: clusterStatus: description: Cluster status. $ref: '#/definitions/CommonStatusMessage' validationResponse: description: Pre-flight validation check response. Only given on a validation failure and `skipValidation` is false. $ref: '#/definitions/ValidationResponse' x-form-factors: public ResumeClusterRequest: type: object description: Request structure to resume the compute cluster required: - clusterCrn properties: clusterCrn: type: string description: Compute cluster CRN. skipValidation: type: boolean description: Whether to skip validation. x-form-factors: public ResumeClusterResponse: type: object description: Response structure for resuming the compute cluster properties: clusterStatus: description: Cluster status. $ref: '#/definitions/CommonStatusMessage' validationResponse: description: Pre-flight validation check response. Only given on a validation failure and `skipValidation` is false. $ref: '#/definitions/ValidationResponse' x-form-factors: public WorkflowOperation: type: string description: "Defines the type of workflow operation.\n `UNKNOWN` - The operation is unknown. `UPGRADE` - Represents an upgrade operation. `SUSPEND` - Represents a suspend operation. `RESUME` - Represents a resume operation. `UPDATE` - Represents an update operation." enum: - UNKNOWN - UPGRADE - SUSPEND - RESUME - UPDATE ExecutionStatus: type: string description: "Defines the execution status of an operation, workflow or activity.\n `UNKNOWN` - The execution status is unknown. `RUNNING` - The execution is currently running. `COMPLETED` - The execution has completed successfully. `FAILED` - The execution has failed. `CANCELLED` - The execution has been cancelled. `TIMED_OUT` - The execution has timed out." enum: - UNKNOWN - RUNNING - COMPLETED - FAILED - CANCELLED - TIMED_OUT WorkflowPhase: type: string description: "Defines the workflow phases of an operation.\n `UNKNOWN` - The workflow phase of operation is unknown. `VALIDATE` - The operation is in validation workflow phase. `PREPARE` - The operation is in preparation workflow phase. `EXECUTE` - The operation is in execution workflow phase. `FINALIZE` - The operation is in finalization workflow phase." enum: - UNKNOWN - VALIDATE - PREPARE - EXECUTE - FINALIZE UpgradeClusterRequest: type: object description: Request structure to upgrade the cluster kubernetes version. required: - clusterCrn properties: clusterCrn: type: string description: Compute cluster CRN. dryRun: type: boolean description: Flag to only run validations. UpgradeClusterResponse: type: object description: Response structure for upgrading the cluster kubernetes version. properties: operationId: type: string description: The unique ID of the initiated long running upgrade operation. x-form-factors: public GetOperationStatusRequest: type: object description: Represents a request to get the status of an operation. required: - operationId properties: operationId: type: string description: The unique ID of the operation to query. GetOperationStatusResponse: type: object description: Represents the response containing the status of an operation. properties: operationId: type: string description: The unique ID of the operation. workflowOperation: description: The type of workflow for this operation. $ref: '#/definitions/WorkflowOperation' operationStatus: description: The current status of the operation. $ref: '#/definitions/ExecutionStatus' message: type: string description: Additional details regarding operation status. clusterCrn: type: string description: The CRN of the cluster associated with the operation. startTime: type: string format: date-time description: The start time of the operation. lastUpdateTime: type: string format: date-time description: The last time the operation status was updated. workflowId: type: string description: Cadence workflow ID. runId: type: string description: Cadence run ID. phaseWorkflowStatuses: type: array items: $ref: '#/definitions/PhaseWorkflowStatus' description: Status of workflow phases. AppWorkflowStatus: type: object description: Status of an application workflow. properties: workflowStatus: description: Workflow status. $ref: '#/definitions/ExecutionStatus' message: type: string description: Additional details regarding workflow status. appCrn: type: string description: Application CRN. startTime: type: string format: date-time description: The start time of the workflow. lastUpdateTime: type: string format: date-time description: The last time the workflow status was updated. PhaseWorkflowStatus: type: object description: Status of phase workflow. properties: workflowPhase: description: Workflow phase. $ref: '#/definitions/WorkflowPhase' workflowStatus: description: Workflow status. $ref: '#/definitions/ExecutionStatus' message: type: string description: Additional details regarding workflow status. startTime: type: string format: date-time description: The start time of the workflow. lastUpdateTime: type: string format: date-time description: The last time the workflow status was updated. appWorkflowStatuses: type: array items: $ref: '#/definitions/AppWorkflowStatus' description: Status of application workflow. GetOperationDetailsRequest: type: object description: Represents a request to get the details of an operation. properties: operationId: type: string description: The unique ID of the operation to query. runId: type: string description: Cadence run ID. GetOperationDetailsResponse: type: object description: Represents the response containing the details of an operation. properties: operationId: type: string description: The unique ID of the operation. workflowOperation: description: The type of workflow for this operation. $ref: '#/definitions/WorkflowOperation' operationStatus: description: The current status of the operation. $ref: '#/definitions/ExecutionStatus' message: type: string description: Additional details regarding operation status. clusterCrn: type: string description: The CRN of the cluster associated with the operation. startTime: type: string format: date-time description: The start time of the operation. lastUpdateTime: type: string format: date-time description: The last time the operation status was updated. operationOwner: description: Details of operation owner. $ref: '#/definitions/OperationOwner' retryCount: type: integer format: int32 description: Number of retires attempted. Its value is 0 for first operation. workflowId: type: string description: Cadence workflow ID. runId: type: string description: Cadence run ID. phaseWorkflowDetails: type: array items: $ref: '#/definitions/PhaseWorkflowDetail' description: Details of workflow phases. activities: type: array items: $ref: '#/definitions/Activity' description: Activities OperationOwner: type: object description: Operation owner structure. properties: userId: type: string description: Owner's user ID. accountId: type: string description: Owner's account ID. crn: type: string description: Owner's actor CRN. PhaseWorkflowDetail: type: object description: Details of phase workflow. properties: workflowPhase: description: Workflow phase. $ref: '#/definitions/WorkflowPhase' workflowStatus: description: Workflow status. $ref: '#/definitions/ExecutionStatus' message: type: string description: Additional details regarding workflow status. startTime: type: string format: date-time description: The start time of the workflow. lastUpdateTime: type: string format: date-time description: The last time the workflow status was updated. workflowId: type: string description: Cadence workflow ID. runId: type: string description: Cadence run ID. appWorkflowDetails: type: array items: $ref: '#/definitions/AppWorkflowDetail' description: Details of application workflow. activities: type: array items: $ref: '#/definitions/Activity' description: Activities AppWorkflowDetail: type: object description: Details of an application workflow. properties: workflowStatus: description: Workflow status. $ref: '#/definitions/ExecutionStatus' message: type: string description: Additional details regarding workflow status. appCrn: type: string description: Application CRN. startTime: type: string format: date-time description: The start time of the workflow. lastUpdateTime: type: string format: date-time description: The last time the workflow status was updated. domain: type: string description: Domain of workflow. taskList: type: string description: List of tasks for workflows. workflowName: type: string description: Name of the workflow. workflowId: type: string description: Cadence workflow ID. runId: type: string description: Cadence run ID. activities: type: array items: $ref: '#/definitions/Activity' description: Activities Activity: type: object description: Represents an individual activity within a workflow execution. properties: activityId: type: string description: Unique identifier for this activity instance. name: type: string description: Human-readable name of the activity. status: description: Current execution status of the activity. $ref: '#/definitions/ExecutionStatus' startedAt: type: string format: date-time description: Time when the activity started execution. completedAt: type: string format: date-time description: Time when the activity completed execution. logs: type: array items: type: string description: Collection of log messages generated during activity execution. RetryOperationRequest: type: object description: Represents a request to structure of retry operation. properties: operationId: type: string description: The unique ID of the operation to retry. RetryOperationResponse: type: object description: Represents a response to structure of retry operation. properties: operationId: type: string description: The unique ID of the retried operation. x-audit: true