The identity and technical contract details declared by the specification.
NodeTypeShapeConfig
object
Shape configuration at node type level. Start cluster will start all nodes as is if no config is specified.
2 properties
2 required
BackupNodeDetails
object
The information about the nodes to backup.
2 properties
1 required
TestBdsObjectStorageConnectionDetails
object
Test access to specified Object Storage bucket using the API key.
3 properties
2 required
ManageBdsCertificateLevelTypeDetails
object
Details of the type of level used to trigger certificate generation or renewal.
1 property
1 required
OsPatchPackageSummary
object
Summary of a package contained in a os patch.
5 properties
3 required
DeactivateUpstConfigurationDetails
object
Details for deleting UPST config from cluster
2 properties
RemoveCloudSqlDetails
object
The information about the Cloud SQL installation that was removed.
1 property
HostSpecificCertificateDetails
object
Host specific certificate details
3 properties
AddAutoScalingConfigurationDetails
object
The information about the autoscale configuration.
7 properties
2 required
ForceRefreshResourcePrincipalDetails
object
Force Refresh Resource Principal Session Token Details.
2 properties
UpdateResourcePrincipalConfigurationDetails
object
Details of updating the resource principal configuration for the cluster.
2 properties
NodeReplaceConfiguration
object
The information about the NodeReplaceConfiguration.
10 properties
9 required
UpdateBdsMetastoreConfigurationDetails
object
The request body when updating BDS metastore configuration.
5 properties
NodeBackupSummary
object
The information about the nodeBackupSummary.
8 properties
8 required
IdentityConfigurationSummary
object
Summary of the identity config
3 properties
3 required
BdsMetastoreConfiguration
object
The metastore configuration information.
9 properties
5 required
SoftwareUpdateSummary
object
The software update that is currently available for the cluster.
5 properties
5 required
PatchSummary
object
The patch that is currently available for the cluster.
2 properties
2 required
CreateBdsCapacityReportDetails
object
The data to create a report of available BDS capacity.
2 properties
2 required
IamUserSyncConfiguration
object
Information about the IAM user sync configuration.
4 properties
4 required
BdsInstance
object
Description of the cluster.
27 properties
10 required
MetricThresholdRule
object
An autoscale action is triggered when a performance metric exceeds a threshold.
3 properties
3 required
iamUserSyncConfigurationDetails
object
Details for activating/updating an IAM user sync configuration
1 property
AutoScalePolicy
object
This model for autoscaling policy is deprecated and not supported for ODH clusters. Use the AutoScalePolicyDetails model to manage autoscale policy details for…
2 properties
2 required
AddUtilityNodesDetails
object
The information about added utility nodes.
6 properties
1 required
RemoveKafkaDetails
object
The information about the Kafka installation to be removed. All configured Kafka nodes are considered for removal.
2 properties
StartClusterShapeConfigs
object
The shape configuration to be used to start the cluster. If the value is not set, the start cluster operation will try to start the cluster as is.
1 property
1 required
RefreshUpstTokenExchangeKeytabDetails
object
Details for refreshing User Principal Session (UPST) token exchange keytab
2 properties
StopBdsInstanceDetails
object
The request body for stopping a BDS cluster.
3 properties
UpstConfiguration
object
Information about the UPST configuration.
9 properties
8 required
NetworkConfig
object
Additional configuration of the user's network.
2 properties
ChangeShapeDetails
object
Resize details specified for individual nodes.
3 properties
1 required
RemoveResourcePrincipalConfigurationDetails
object
Details of removing a resource principal configuration for the cluster.
2 properties
SoftwareUpdate
object
Details about the given software update.
5 properties
5 required
CreateNodeDetails
object
The information about the new node.
5 properties
4 required
CertificateServiceInfoDetails
object
Details for certificate service info
1 property
1 required
CreateCapacityReportShapeAvailabilityDetails
object
Information about the shapes in a capacity report.
2 properties
1 required
Service
string
The type of service.
ActivateIamUserSyncConfigurationDetails
object
Details for activating IAM user sync configuration
3 properties
OsPatchDetails
object
Details of an os patch.
6 properties
6 required
InstallOsPatchDetails
object
Os patch details for installing a os patches to a cluster.
5 properties
1 required
BdsCertificateConfiguration
object
The BDS certificate configuration information.
11 properties
8 required
AddAutoScalePolicyDetails
object
Policy definition for the autoscale configuration. An autoscaling policy is part of an autoscaling configuration. For more information, see [Autoscaling](/iaas…
1 property
1 required
CreateIdentityConfigurationDetails
object
Details for creating the identity configuration.
7 properties
3 required
BdsCertificateConfigurationSummary
object
Summary details of the BDS certificate configuration.
13 properties
4 required
NodeBackupConfigurationSummary
object
The information about the NodeBackupConfiguration.
7 properties
7 required
RenewBdsCertificateDetails
object
Request body for renewing certificates.
3 properties
1 required
DeactivateIamUserSyncConfigurationDetails
object
Details for deactivating an IAM user sync configuration
2 properties
BdsInstanceSummary
object
Summary details of the Big Data Service cluster.
16 properties
10 required
InstallPatchDetails
object
The reqeust body while installing a patch to a cluster.
4 properties
1 required
DefaultError
object
Error Information.
2 properties
2 required
AutoScalePolicyRule
object
A rule that defines a specific autoscale action to take and the metric that triggers that action.
2 properties
2 required
NodeReplaceConfigurationSummary
object
The information about the NodeReplaceConfigurationSummary.
7 properties
7 required
UpdateBdsInstanceDetails
object
The information about to-be-updated Big Data Service cluster.
8 properties
TestBdsMetastoreConfigurationDetails
object
The reqeust body when testing a BDS metastore configuration
2 properties
CapacityReportShapeAvailability
object
Detailed information about the availabilities of a shape in each domain.
3 properties
2 required
AddWorkerNodesDetails
object
The information about added nodes.
7 properties
2 required
ShapeConfigDetails
object
The shape configuration requested for the node.
3 properties
RefreshConfidentialApplicationDetails
object
Details for refreshing confidential application
2 properties
InstallSoftwareUpdatesDetails
object
Details for installing a software update to a cluster.
1 property
1 required
ChangeShapeNodes
object
Individual worker nodes groups details.
14 properties
EnableCertificateDetails
object
The request body info about configure certificate service list.
6 properties
1 required
UpdateAutoScalePolicyDetails
object
Update details of an autoscaling policy.
1 property
1 required
BdsApiKeySummary
object
The API key summary.
5 properties
5 required
upstConfigurationDetails
object
Details for activating/updating UPST config on the cluster
2 properties
CreateBdsMetastoreConfigurationDetails
object
The request body when creating BDS metastore configuration.
6 properties
3 required
PatchingConfigs
object
Detailed configurations for defining the behavior when installing os patches. If not provided, nodes will be patched and rebooted AD/FD by AD/FD for regular pa…
1 property
1 required
ClusterDetails
object
Specific info about a Hadoop cluster
15 properties
1 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties
2 required
WorkRequest
object
Description of the work request status.
9 properties
7 required
UpdateNodeBackupConfigurationDetails
object
The information about the NodeBackupConfiguration that is being updated.
6 properties
CloudSqlDetails
object
The information about added Cloud SQL capability
5 properties
2 required
GenerateBdsCertificateDetails
object
Request body for generating certificates.
3 properties
1 required
CreateBdsApiKeyDetails
object
API key created on user's behalf.
5 properties
3 required
AutoScalingConfiguration
object
The information about the autoscale configuration.
9 properties
7 required
AddKafkaDetails
object
The information about the Kafka service to be added.
6 properties
2 required
Node
object
Details about a node.
26 properties
11 required
ActivateUpstConfigurationDetails
object
Details for activating UPST config on the cluster
4 properties
2 required
RestartNodeDetails
object
The information about restarted node.
1 property
1 required
CreateBdsInstanceDetails
object
The information about the new cluster.
17 properties
7 required
ResourcePrincipalConfigurationSummary
object
Resource Principal Session Token Details.
8 properties
6 required
VolumeAttachmentDetail
object
A detail of the attached block volume.
2 properties
2 required
StartBdsInstanceDetails
object
The request body for starting a BDS cluster.
3 properties
AddCloudSqlDetails
object
The information about the added Cloud SQL.
4 properties
1 required
AddMasterNodesDetails
object
The information about added master nodes.
6 properties
1 required
OdhPatchingConfig
object
Detailed configurations for defining the behavior when installing ODH patches. If not provided, nodes will be patched with down time.
1 property
1 required
UpdateNodeReplaceConfigurationDetails
object
The information about the NodeReplaceConfiguration
4 properties
NodeBackupConfiguration
object
The information about the NodeBackupConfiguration.
11 properties
10 required
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties
3 required
BdsApiKey
object
The API key information.
10 properties
8 required
PasswordSummary
object
New password value for the target service.
1 property
1 required
CreateResourcePrincipalConfigurationDetails
object
Details of creating a resource principal configuration for the cluster.
4 properties
1 required
ActivateBdsMetastoreConfigurationDetails
object
The reqeust body when activating a BDS metastore configuration
3 properties
BdsCapacityReport
object
A report of the host capacity within an availability domain that is available for you to create bds clusters. Host capacity is the physical infrastructure that…
3 properties
3 required
WorkRequestError
object
An error encountered while executing a work request.
3 properties
3 required
ExecuteBootstrapScriptDetails
object
The information about the bootstrap script to be executed.
3 properties
DisableCertificateDetails
object
The request body info about disable certificate service list.
3 properties
1 required
KerberosDetails
object
Details about the Kerberos principals.
2 properties
2 required
HostCertDetails
object
Details about the host and corresponding certificate.
3 properties
3 required
BdsInstanceResetPasswordDetails
object
The request body for resetting the password of indicated component.
3 properties
1 required
RemoveNodeReplaceConfigurationDetails
object
The information about the NodeReplaceConfiguration that being removed.
2 properties
AddBlockStorageDetails
object
The information about added block volumes.
5 properties
2 required
BdsMetastoreConfigurationSummary
object
The summary of metastore configuration information.
8 properties
5 required
AutoScalePolicyMetricRule
object
Metric and threshold details for triggering an autoscale action.
2 properties
2 required
AutoScalingConfigurationSummary
object
The information about the autoscale configuration.
8 properties
7 required
ChangeBdsInstanceCompartmentDetails
object
Move a Cluster to a Different Compartment
1 property
1 required
LevelTypeDetails
object
Details of the type of level used to trigger the creation of a new node backup configuration or node replacement configuration.
1 property
1 required
UpdateIdentityConfigurationDetails
object
Details for updating identity config on the cluster
4 properties
RemoveAutoScalingConfigurationDetails
object
The information about the removed autoscale configuration.
2 properties
RenewCertificateDetails
object
The request body info about renew certificate service list.
6 properties
SoftwareUpdateCollection
object
Results of a software update search. Contains both software update summaries and a summary of the search.
1 property
1 required
CreateNodeBackupConfigurationDetails
object
The information about the NodeBackupConfiguration.
6 properties
2 required
IdentityConfiguration
object
Details about the identity configuration
10 properties
7 required
RemoveNodesDetails
object
The information about the list of nodes to be removed.
4 properties
1 required
PatchHistorySummary
object
Patch history of this cluster.
4 properties
4 required
CertificateServiceInfoSummary
object
List of TLS/SSL information of services
3 properties
3 required
NodeBackup
object
The information about the Node's backup.
9 properties
8 required
SetDefaultBdsCertificateConfigurationDetails
object
The request body for configuring BDS certificate configuration as default configuration.
2 properties
CreateBdsCertificateConfigurationDetails
object
The request body for generating BDS certificate configuration.
4 properties
2 required
CreateNodeReplaceConfigurationDetails
object
The information about the NodeReplaceConfiguration
6 properties
3 required
UpdateAutoScalingConfigurationDetails
object
The information about the autoscale configuration.
6 properties
OsPatchSummary
object
Summary of an available os patch to a cluster.
2 properties
2 required
RemoveNodeDetails
object
The information about node to be removed.
4 properties
1 required
ReplaceNodeDetails
object
The information about the node to be replaced.
5 properties
2 required
DomainTypeCapacityReport
object
Detailed information of the capacity under a domain.
1 property
1 required
ResourcePrincipalConfiguration
object
Resource Principal Session Token Details.
10 properties
7 required
AutoScalePolicyDetails
object
Details of an autoscale policy. You can create following types of autoscaling policies: - MetricBasedVerticalScalingPolicy: Vertical autoscaling action is trig…
3 properties
3 required
BdsClusterVersionSummary
object
Cluster version details including bds and odh version information.
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle publishes across the network.