How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Bds API

The bds API from Oracle — 74 operation(s) for bds.

Oracle Bds API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BDS. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 97 operations across 74 paths, and defines 128 schemas. It is described by OpenAPI 3.2.0, at version 20190531.

Requests are made against a single base URL, /20190531.

97 operations 74 paths 128 schemas 7 DELETE29 GET54 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20190531
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 97

Across 74 paths, the API surfaces 97 operations — 7 DELETE, 29 GET, 54 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

bds 97
POST
/bdsCapacityReports
Create a Bds Capacity Report
CreateBdsCapacityReport 2 params body → 200400401404409429500default
GET
/bdsClusterVersions
List cluster versions available for creation
ListBdsClusterVersions 5 params → 200400401404429500default
GET
/bdsInstances
View the Clusters in a Compartment
ListBdsInstances 8 params → 200400401404429500default
POST
/bdsInstances
Create a Cluster
CreateBdsInstance 2 params body → 202400401404409429500default
DELETE
/bdsInstances/{bdsInstanceId}
Delete a Cluster
DeleteBdsInstance 3 params → 202400401404412429500default
GET
/bdsInstances/{bdsInstanceId}
View a Cluster
GetBdsInstance 2 params → 200400401404429500default
PUT
/bdsInstances/{bdsInstanceId}
Update a Cluster
UpdateBdsInstance 3 params body → 202400401404412429500default
POST
/bdsInstances/{bdsInstanceId}/actions/addBlockStorage
Add Block Storage to a Cluster
AddBlockStorage 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/addCloudSql
Add Cloud SQL to a Cluster
AddCloudSql 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/addKafka
Add Kafka to a Cluster
AddKafka 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/addMasterNodes
Add Master Nodes to a Cluster
AddMasterNodes 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/addUtilityNodes
Add Utility Nodes to a Cluster
AddUtilityNodes 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/addWorkerNodes
Add Worker Nodes to a Cluster
AddWorkerNodes 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/backupNodes
Takes the backup of given nodes.
BackupNode 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/changeCompartment
Move a Cluster to a Different Compartment
ChangeBdsInstanceCompartment 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/changeShape
Resize a Cluster by Changing Node Shapes
ChangeShape 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/disableOdhServiceCertificate
Disabling TLS/SSL Encryption for ODH Services.
DisableCertificate 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/enableOdhServiceCertificate
Configuring TLS/SSL Encryption for ODH Services.
EnableCertificate 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/executeBootstrapScript
Execute bootstrap script.
ExecuteBootstrapScript 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/fetchOdhServiceCertificate
A list of services and their certificate details.
CertificateServiceInfo 4 params body → 200400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/generateBdsCertificate
Generating certificates under BDS cluster nodes.
GenerateBdsCertificate 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/getOsPatch
Get the details of an os patch
GetOsPatchDetails 5 params → 200401404409412429500default
POST
/bdsInstances/{bdsInstanceId}/actions/installOsPatch
Install an os patch on a cluster
InstallOsPatch 4 params body → 202401404409412429500default
POST
/bdsInstances/{bdsInstanceId}/actions/installPatch
Install the specified patch to this cluster.
InstallPatch 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/installSoftwareUpdates
Install the specified software update to this cluster.
InstallSoftwareUpdates 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/listOsPatches
List all available os patches for a given cluster
ListOsPatches 8 params → 200401404409412429500default
POST
/bdsInstances/{bdsInstanceId}/actions/removeCloudSql
Remove Cloud SQL from a Cluster
RemoveCloudSql 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/removeKafka
Remove Kafka from the cluster.
RemoveKafka 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/removeNode
Remove a Node
RemoveNode 3 params body → 202400401404412429500default
POST
/bdsInstances/{bdsInstanceId}/actions/removeNodes
Remove multiple Nodes
RemoveNodes 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/renewBdsCertificate
Renewing certificates under BDS cluster nodes.
RenewBdsCertificate 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/renewOdhServiceCertificate
Renewing TLS/SSL Encryption for ODH Services.
RenewCertificate 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/replaceNode
Replace a failed node using its backup.
ReplaceNode 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/resetPassword
Reset the indicated service's password.
BdsInstanceResetPassword 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/restartNode
Restart a Node
RestartNode 4 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/start
Starts the BDS cluster.
StartBdsInstance 3 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/actions/stop
Stops the BDS cluster.
StopBdsInstance 3 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/apiKeys
View all API keys associated with this Big Data Service cluster.
ListBdsApiKeys 9 params → 200400401404429500default
POST
/bdsInstances/{bdsInstanceId}/apiKeys
Create a user API key.
CreateBdsApiKey 3 params body → 202400401404409429500default
DELETE
/bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}
Delete a user's API key.
DeleteBdsApiKey 4 params → 202400401404412429500default
GET
/bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}
View user's API key information.
GetBdsApiKey 3 params → 200400401404429500default
POST
/bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}/actions/testObjectStorageConnection
Test access to specified Object Storage bucket.
TestBdsObjectStorageConnection 3 params body → 202400401404409429500default
GET
/bdsInstances/{bdsInstanceId}/autoScalingConfiguration
View Autoscale Configurations
ListAutoScalingConfigurations 9 params → 200400401404429500default
POST
/bdsInstances/{bdsInstanceId}/autoScalingConfiguration
Add an Autoscale Configuration to a Cluster
AddAutoScalingConfiguration 4 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/autoScalingConfiguration/{autoScalingConfigurationId}
View Details of an Autoscale Configuration
GetAutoScalingConfiguration 3 params → 200400401404412429500default
PUT
/bdsInstances/{bdsInstanceId}/autoScalingConfiguration/{autoScalingConfigurationId}
Modify an Autoscale Configuration
UpdateAutoScalingConfiguration 5 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/autoScalingConfiguration/{autoScalingConfigurationId}/actions/remove
Delete an Autoscale Configuration
RemoveAutoScalingConfiguration 5 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations
View all BDS certificate configurations associated with this Big Data Service cluster.
ListBdsCertificateConfigurations 8 params → 200400401404429500default
POST
/bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations
Create a BDS certificate configuration for the cluster.
CreateBdsCertificateConfiguration 3 params body → 202400401404409412429500
DELETE
/bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations/{bdsCertificateConfigurationId}
Delete the BDS certificate configuration for the given ID.
DeleteBdsCertificateConfiguration 5 params → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations/{bdsCertificateConfigurationId}
View Details of the indicated BdsCertificateConfiguration
GetBdsCertificateConfiguration 3 params → 200400401404412429500default
POST
/bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations/{bdsCertificateConfigurationId}/actions/setDefault
Set specified BDS certificate configuration as default configuration.
SetDefaultBdsCertificateConfiguration 5 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/identityConfigurations
View all identity configurations associated with this Big Data Service cluster.
ListIdentityConfigurations 9 params → 200400401404429500default
POST
/bdsInstances/{bdsInstanceId}/identityConfigurations
Create an identity configuration for the cluster
CreateIdentityConfiguration 3 params body → 202400401404409429500default
DELETE
/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}
Delete the specified identity configuration
DeleteIdentityConfiguration 4 params → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}
Get details of one identity config on the cluster
GetIdentityConfiguration 7 params → 200400401404429500default
PUT
/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}
Update the IAM user sync and UPST configuration for the specified identity configuration
UpdateIdentityConfiguration 5 params body → 202400401404412409429500
POST
/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/activateIamUserSyncConfiguration
Activate IAM user sync configuration for the given identity configuration
ActivateIamUserSyncConfiguration 5 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/activateUpstConfiguration
Activate UPST configuration for the given identity configuration
ActivateUpstConfiguration 5 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/deactivateIamUserSyncConfiguration
Deactivate the specified IAM user sync configuration
DeactivateIamUserSyncConfiguration 5 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/deactivateUpstConfiguration
Deactivate the specified UPST configuration
DeactivateUpstConfiguration 5 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/refreshConfidentialApplication
Refresh confidential application
RefreshConfidentialApplication 5 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/refreshUpstTokenExchangeKeytab
Refresh token exchange kerberos principal keytab for the UPST enabled identity configuration
RefreshUpstTokenExchangeKeytab 5 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/metastoreConfigs
View all metastore configurations associated with this Big Data Service cluster.
ListBdsMetastoreConfigurations 11 params → 200400401404429500default
POST
/bdsInstances/{bdsInstanceId}/metastoreConfigs
Create and activate external metastore configuration.
CreateBdsMetastoreConfiguration 3 params body → 202400401404409429500default
DELETE
/bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}
Delete a BDS metastore configuration.
DeleteBdsMetastoreConfiguration 4 params → 202400401404412429500default
GET
/bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}
View BDS Metastore configuration information.
GetBdsMetastoreConfiguration 3 params → 200400401404429500default
PUT
/bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}
Update a BDS metastore configuration.
UpdateBdsMetastoreConfiguration 4 params body → 202400401404412429500default
POST
/bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}/actions/activate
Activate specified metastore configuration.
ActivateBdsMetastoreConfiguration 5 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}/actions/test
Test specified metastore configuration.
TestBdsMetastoreConfiguration 4 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations
View the list of NodeBackupConfigurations
ListNodeBackupConfigurations 8 params → 200400401404429500default
POST
/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations
Add a nodeBackupConfiguration to the indicated BDS Cluster for an indicated node type or node.
CreateNodeBackupConfiguration 3 params body → 202400401404409412429500
DELETE
/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId}
Delete a NodeBackupConfiguration
DeleteNodeBackupConfiguration 4 params → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId}
View Details of the indicated NodeBackupConfiguration
GetNodeBackupConfiguration 3 params → 200400401404412429500default
PUT
/bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId}
Modify a NodeBackupConfiguration
UpdateNodeBackupConfiguration 5 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/nodeBackups
View List of NodeBackups
ListNodeBackups 9 params → 200400401404429500default
DELETE
/bdsInstances/{bdsInstanceId}/nodeBackups/{nodeBackupId}
Delete a NodeBackup
DeleteNodeBackup 4 params → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/nodeBackups/{nodeBackupId}
View Details of NodeBackup
GetNodeBackup 3 params → 200400401404412429500default
GET
/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations
View the list of NodeReplaceConfigurations
ListNodeReplaceConfigurations 8 params → 200400401404429500default
POST
/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations
Add nodeReplaceConfiguration to the BDS Cluster for a node type.
CreateNodeReplaceConfiguration 3 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations/{nodeReplaceConfigurationId}
View Details of the indicated nodeReplaceConfiguration
GetNodeReplaceConfiguration 3 params → 200400401404412429500default
PUT
/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations/{nodeReplaceConfigurationId}
Modify a nodeReplaceConfigurations
UpdateNodeReplaceConfiguration 5 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations/{nodeReplaceConfigurationId}/actions/remove
Delete a nodeReplaceConfiguration
RemoveNodeReplaceConfiguration 5 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/patchHistory
List the patch history of this cluster.
ListPatchHistories 9 params → 200400401404429500default
GET
/bdsInstances/{bdsInstanceId}/patches
List all the available patches for this cluster.
ListPatches 4 params → 200400401404429500default
GET
/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations
View the list of ResourcePrincipalConfigurations
ListResourcePrincipalConfigurations 8 params → 200400401404429500default
POST
/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations
Create a resource principal configuration for the cluster.
CreateResourcePrincipalConfiguration 3 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}
View Details of the indicated resourcePrincipalConfiguration
GetResourcePrincipalConfiguration 3 params → 200400401404412429500default
PUT
/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}
Modify a resourcePrincipalConfiguration
UpdateResourcePrincipalConfiguration 5 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}/actions/forceRefreshResourcePrincipal
Force Refresh Resource Principal for the cluster.
ForceRefreshResourcePrincipal 5 params body → 202400401404409412429500
POST
/bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}/actions/remove
Delete a ResourcePrincipalConfiguration.
RemoveResourcePrincipalConfiguration 4 params body → 202400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/softwareUpdates
List all the available software updates for current cluster.
ListSoftwareUpdates 8 params → 200400401404409412429500
GET
/bdsInstances/{bdsInstanceId}/softwareUpdates/{softwareUpdateKey}
Get the details of the software update of the given SoftwareUpdateId
GetSoftwareUpdate 5 params → 200400401404409412429500
GET
/workRequests
List Work Requests
ListWorkRequests 7 params → 200400401404429500default
GET
/workRequests/{workRequestId}
View the Status of a Work Request
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
List Work Request Errors
ListWorkRequestErrors 6 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
List Work Request Logs
ListWorkRequestLogs 6 params → 200400401404429500default

Schemas 128

The contract defines 128 schemas that model the data the API accepts and returns. The most detailed are BdsInstance (27 properties), Node (26 properties), CreateBdsInstanceDetails (17 properties), BdsInstanceSummary (16 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-bds-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Bds API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.