Oracle

Oracle Bds API

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

GitHub OpenAPI

Operations 97

POST /bdsCapacityReports Create a Bds Capacity Report #
GET /bdsClusterVersions List cluster versions available for creation #
GET /bdsInstances View the Clusters in a Compartment #
POST /bdsInstances Create a Cluster #
DELETE /bdsInstances/{bdsInstanceId} Delete a Cluster #
GET /bdsInstances/{bdsInstanceId} View a Cluster #
PUT /bdsInstances/{bdsInstanceId} Update a Cluster #
POST /bdsInstances/{bdsInstanceId}/actions/addBlockStorage Add Block Storage to a Cluster #
POST /bdsInstances/{bdsInstanceId}/actions/addCloudSql Add Cloud SQL to a Cluster #
POST /bdsInstances/{bdsInstanceId}/actions/addKafka Add Kafka to a Cluster #
POST /bdsInstances/{bdsInstanceId}/actions/addMasterNodes Add Master Nodes to a Cluster #
POST /bdsInstances/{bdsInstanceId}/actions/addUtilityNodes Add Utility Nodes to a Cluster #
POST /bdsInstances/{bdsInstanceId}/actions/addWorkerNodes Add Worker Nodes to a Cluster #
POST /bdsInstances/{bdsInstanceId}/actions/backupNodes Takes the backup of given nodes. #
POST /bdsInstances/{bdsInstanceId}/actions/changeCompartment Move a Cluster to a Different Compartment #
POST /bdsInstances/{bdsInstanceId}/actions/changeShape Resize a Cluster by Changing Node Shapes #
POST /bdsInstances/{bdsInstanceId}/actions/disableOdhServiceCertificate Disabling TLS/SSL Encryption for ODH Services. #
POST /bdsInstances/{bdsInstanceId}/actions/enableOdhServiceCertificate Configuring TLS/SSL Encryption for ODH Services. #
POST /bdsInstances/{bdsInstanceId}/actions/executeBootstrapScript Execute bootstrap script. #
POST /bdsInstances/{bdsInstanceId}/actions/fetchOdhServiceCertificate A list of services and their certificate details. #
POST /bdsInstances/{bdsInstanceId}/actions/generateBdsCertificate Generating certificates under BDS cluster nodes. #
POST /bdsInstances/{bdsInstanceId}/actions/getOsPatch #
POST /bdsInstances/{bdsInstanceId}/actions/installOsPatch #
POST /bdsInstances/{bdsInstanceId}/actions/installPatch Install the specified patch to this cluster. #
POST /bdsInstances/{bdsInstanceId}/actions/installSoftwareUpdates Install the specified software update to this cluster. #
POST /bdsInstances/{bdsInstanceId}/actions/listOsPatches #
POST /bdsInstances/{bdsInstanceId}/actions/removeCloudSql Remove Cloud SQL from a Cluster #
POST /bdsInstances/{bdsInstanceId}/actions/removeKafka Remove Kafka from the cluster. #
POST /bdsInstances/{bdsInstanceId}/actions/removeNode Remove a Node #
POST /bdsInstances/{bdsInstanceId}/actions/removeNodes Remove multiple Nodes #
POST /bdsInstances/{bdsInstanceId}/actions/renewBdsCertificate Renewing certificates under BDS cluster nodes. #
POST /bdsInstances/{bdsInstanceId}/actions/renewOdhServiceCertificate Renewing TLS/SSL Encryption for ODH Services. #
POST /bdsInstances/{bdsInstanceId}/actions/replaceNode Replace a failed node using its backup. #
POST /bdsInstances/{bdsInstanceId}/actions/resetPassword Reset the indicated service's password. #
POST /bdsInstances/{bdsInstanceId}/actions/restartNode Restart a Node #
POST /bdsInstances/{bdsInstanceId}/actions/start Starts the BDS cluster. #
POST /bdsInstances/{bdsInstanceId}/actions/stop Stops the BDS cluster. #
GET /bdsInstances/{bdsInstanceId}/apiKeys View all API keys associated with this Big Data Service cluster. #
POST /bdsInstances/{bdsInstanceId}/apiKeys Create a user API key. #
DELETE /bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId} Delete a user's API key. #
GET /bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId} View user's API key information. #
POST /bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}/actions/testObjectStorageConnection Test access to specified Object Storage bucket. #
GET /bdsInstances/{bdsInstanceId}/autoScalingConfiguration View Autoscale Configurations #
POST /bdsInstances/{bdsInstanceId}/autoScalingConfiguration Add an Autoscale Configuration to a Cluster #
GET /bdsInstances/{bdsInstanceId}/autoScalingConfiguration/{autoScalingConfigurationId} View Details of an Autoscale Configuration #
PUT /bdsInstances/{bdsInstanceId}/autoScalingConfiguration/{autoScalingConfigurationId} Modify an Autoscale Configuration #
POST /bdsInstances/{bdsInstanceId}/autoScalingConfiguration/{autoScalingConfigurationId}/actions/remove Delete an Autoscale Configuration #
GET /bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations View all BDS certificate configurations associated with this Big Data Service cluster. #
POST /bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations Create a BDS certificate configuration for the cluster. #
DELETE /bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations/{bdsCertificateConfigurationId} Delete the BDS certificate configuration for the given ID. #
GET /bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations/{bdsCertificateConfigurationId} View Details of the indicated BdsCertificateConfiguration #
POST /bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations/{bdsCertificateConfigurationId}/actions/setDefault Set specified BDS certificate configuration as default configuration. #
GET /bdsInstances/{bdsInstanceId}/identityConfigurations View all identity configurations associated with this Big Data Service cluster. #
POST /bdsInstances/{bdsInstanceId}/identityConfigurations Create an identity configuration for the cluster #
DELETE /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId} Delete the specified identity configuration #
GET /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId} Get details of one identity config on the cluster #
PUT /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId} Update the IAM user sync and UPST configuration for the specified identity configuration #
POST /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/activateIamUserSyncConfiguration Activate IAM user sync configuration for the given identity configuration #
POST /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/activateUpstConfiguration Activate UPST configuration for the given identity configuration #
POST /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/deactivateIamUserSyncConfiguration Deactivate the specified IAM user sync configuration #
POST /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/deactivateUpstConfiguration Deactivate the specified UPST configuration #
POST /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/refreshConfidentialApplication Refresh confidential application #
POST /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/refreshUpstTokenExchangeKeytab Refresh token exchange kerberos principal keytab for the UPST enabled identity configuration #
GET /bdsInstances/{bdsInstanceId}/metastoreConfigs View all metastore configurations associated with this Big Data Service cluster. #
POST /bdsInstances/{bdsInstanceId}/metastoreConfigs Create and activate external metastore configuration. #
DELETE /bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId} Delete a BDS metastore configuration. #
GET /bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId} View BDS Metastore configuration information. #
PUT /bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId} Update a BDS metastore configuration. #
POST /bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}/actions/activate Activate specified metastore configuration. #
POST /bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}/actions/test Test specified metastore configuration. #
GET /bdsInstances/{bdsInstanceId}/nodeBackupConfigurations View the list of NodeBackupConfigurations #
POST /bdsInstances/{bdsInstanceId}/nodeBackupConfigurations Add a nodeBackupConfiguration to the indicated BDS Cluster for an indicated node type or node. #
DELETE /bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId} Delete a NodeBackupConfiguration #
GET /bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId} View Details of the indicated NodeBackupConfiguration #
PUT /bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId} Modify a NodeBackupConfiguration #
GET /bdsInstances/{bdsInstanceId}/nodeBackups View List of NodeBackups #
DELETE /bdsInstances/{bdsInstanceId}/nodeBackups/{nodeBackupId} Delete a NodeBackup #
GET /bdsInstances/{bdsInstanceId}/nodeBackups/{nodeBackupId} View Details of NodeBackup #
GET /bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations View the list of NodeReplaceConfigurations #
POST /bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations Add nodeReplaceConfiguration to the BDS Cluster for a node type. #
GET /bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations/{nodeReplaceConfigurationId} View Details of the indicated nodeReplaceConfiguration #
PUT /bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations/{nodeReplaceConfigurationId} Modify a nodeReplaceConfigurations #
POST /bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations/{nodeReplaceConfigurationId}/actions/remove Delete a nodeReplaceConfiguration #
GET /bdsInstances/{bdsInstanceId}/patchHistory List the patch history of this cluster. #
GET /bdsInstances/{bdsInstanceId}/patches List all the available patches for this cluster. #
GET /bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations View the list of ResourcePrincipalConfigurations #
POST /bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations Create a resource principal configuration for the cluster. #
GET /bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId} View Details of the indicated resourcePrincipalConfiguration #
PUT /bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId} Modify a resourcePrincipalConfiguration #
POST /bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}/actions/forceRefreshResourcePrincipal Force Refresh Resource Principal for the cluster. #
POST /bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}/actions/remove Delete a ResourcePrincipalConfiguration. #
GET /bdsInstances/{bdsInstanceId}/softwareUpdates #
GET /bdsInstances/{bdsInstanceId}/softwareUpdates/{softwareUpdateKey} #
GET /workRequests List Work Requests #
GET /workRequests/{workRequestId} View the Status of a Work Request #
GET /workRequests/{workRequestId}/errors List Work Request Errors #
GET /workRequests/{workRequestId}/logs List Work Request Logs #

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-bds-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/oracle-bds-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-bds-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'REST API for Oracle Big Data Service. Use this API to build, deploy, and manage fully elastic Big Data Service clusters. Build on Hadoop, Spark and Data Science distributions, which can be fully integrated with existing enterprise data in Oracle Database and Oracle applications.

    '
  title: Big Data Service Bds API
  version: '20190531'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/3fff4afa0b61b05911fb25ab1754e331bb0c263d4f0561e89fba8bc90cd06dc2.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Big Data Service API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/3fff4afa0b61b05911fb25ab1754e331bb0c263d4f0561e89fba8bc90cd06dc2.yaml
    what: the harvested document for Big Data Service API
servers:
- url: /20190531
tags:
- name: bds
paths:
  /bdsCapacityReports:
    post:
      description: 'Create a detailed capacity report for BDS service

        '
      operationId: CreateBdsCapacityReport
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: A report of the BDS host capacity within an region or availability domain that is available for you to create BDS instances.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BdsCapacityReport'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create a Bds Capacity Report
      tags:
      - bds
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBdsCapacityReportDetails'
        description: Details for the capacity reports requests
        required: true
  /bdsClusterVersions:
    get:
      description: 'Returns a list of cluster versions with associated odh and bds versions.

        '
      operationId: ListBdsClusterVersions
      parameters:
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortByBdsVersionQueryParam'
      - $ref: '#/components/parameters/DefaultDescSortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: List of cluster versions with associated odh and bds versions.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BdsClusterVersionSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: List cluster versions available for creation
      tags:
      - bds
      x-obmcs-authz-declarations:
        authorizationRequired: false
  /bdsInstances:
    get:
      description: 'Returns a list of all Big Data Service clusters in a compartment.

        '
      operationId: ListBdsInstances
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of Big Data Service clusters.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BdsInstanceSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: View the Clusters in a Compartment
      tags:
      - bds
    post:
      description: 'Creates a Big Data Service cluster.

        '
      operationId: CreateBdsInstance
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The cluster will be created.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create a Cluster
      tags:
      - bds
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBdsInstanceDetails'
        description: Details for the new cluster.
        required: true
  /bdsInstances/{bdsInstanceId}:
    delete:
      description: Deletes the cluster identified by the given ID.
      operationId: DeleteBdsInstance
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: Accepted the request. The cluster will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a Cluster
      tags:
      - bds
      x-related-resource: '#/definitions/BdsInstance'
    get:
      description: Returns information about the Big Data Service cluster identified by the given ID.
      operationId: GetBdsInstance
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns information about the cluster identified by the given ID.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BdsInstance'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: View a Cluster
      tags:
      - bds
    put:
      description: Updates the Big Data Service cluster identified by the given ID.
      operationId: UpdateBdsInstance
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The cluster will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Update a Cluster
      tags:
      - bds
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBdsInstanceDetails'
        description: Details for the cluster to be updated.
        required: true
  /bdsInstances/{bdsInstanceId}/actions/addBlockStorage:
    post:
      description: 'Adds block storage to existing worker/compute only worker nodes. The same amount of storage will be added to all worker/compute only worker nodes. No change will be made to storage that is already attached. Block storage cannot be removed.

        '
      operationId: AddBlockStorage
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The additional block volume will be added.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Add Block Storage to a Cluster
      tags:
      - bds
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddBlockStorageDetails'
        description: Details for the added block storage.
        required: true
  /bdsInstances/{bdsInstanceId}/actions/addCloudSql:
    post:
      description: 'Adds Cloud SQL to your cluster. You can use Cloud SQL to query against non-relational data stored in multiple big data sources, including Apache Hive, HDFS, Oracle NoSQL Database, and Apache HBase. Adding Cloud SQL adds a query server node to the cluster and creates cell servers on all the worker nodes in the cluster.

        '
      operationId: AddCloudSql
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. Cloud SQL will be added to the cluster.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Add Cloud SQL to a Cluster
      tags:
      - bds
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCloudSqlDetails'
        description: Details for the Cloud SQL capability
        required: true
  /bdsInstances/{bdsInstanceId}/actions/addKafka:
    post:
      description: 'Adds Kafka to a cluster.

        '
      operationId: AddKafka
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. Kafka will be added to the cluster.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Add Kafka to a Cluster
      tags:
      - bds
      x-example: "POST /20190531/bdsInstances/<var><bdsInstanceId></var>/actions/addKafka\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n<var><authorization and other headers></var>\n{\n  \"shape\" : \"VM.Standard2.1\",\n  \"numberOfKafkaNodes\" : 2,\n  \"blockVolumeSizeInGBs\" : 150,\n  \"clusterAdminPassword\" : \"dGVzdDEyMw==\"\n}\n"
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddKafkaDetails'
        description: Details of the Kafka broker nodes to employ to enable the service.
        required: true
  /bdsInstances/{bdsInstanceId}/actions/addMasterNodes:
    post:
      description: 'Increases the size (scales out) of a cluster by adding master nodes. The added master nodes will have the same shape and will have the same amount of attached block storage as other master nodes in the cluster.

        '
      operationId: AddMasterNodes
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The additional nodes will be added.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Add Master Nodes to a Cluster
      tags:
      - bds
      x-example: "POST /20190531/bdsInstances/<var><bdsInstanceId></var>/actions/addMasterNodes\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n<var><authorization and other headers></var>\n{\n  \"shape\" : \"VM.Standard2.1\",\n  \"numberOfMasterNodes\" : 2,\n  \"blockVolumeSizeInGBs\" : 150,\n  \"clusterAdminPassword\" : \"dGVzdDEyMw==\"\n}\n"
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddMasterNodesDetails'
        description: Details for the newly added nodes.
        required: true
  /bdsInstances/{bdsInstanceId}/actions/addUtilityNodes:
    post:
      description: 'Increases the size (scales out) of a cluster by adding utility nodes. The added utility nodes will have the same shape and will have the same amount of attached block storage as other utility nodes in the cluster.

        '
      operationId: AddUtilityNodes
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The additional nodes will be added.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Add Utility Nodes to a Cluster
      tags:
      - bds
      x-example: "POST /20190531/bdsInstances/<var><bdsInstanceId></var>/actions/addUtilityNodes\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n<var><authorization and other headers></var>\n{\n  \"shape\" : \"VM.Standard2.1\",\n  \"numberOfUtilityNodes\" : 2,\n  \"blockVolumeSizeInGBs\" : 150,\n  \"clusterAdminPassword\" : \"dGVzdDEyMw==\"\n}\n"
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUtilityNodesDetails'
        description: Details for the newly added nodes.
        required: true
  /bdsInstances/{bdsInstanceId}/actions/addWorkerNodes:
    post:
      description: 'Increases the size (scales out) of a cluster by adding worker nodes (data/compute/edge). The added worker and compute only worker nodes will have the same amount of attached block storage as other nodes of the same type in the cluster. Edge nodes can have different block storage sizes within the valid range (50GB-10TB).

        '
      operationId: AddWorkerNodes
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The additional nodes will be added.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Add Worker Nodes to a Cluster
      tags:
      - bds
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddWorkerNodesDetails'
        description: Details for the newly added nodes.
        required: true
  /bdsInstances/{bdsInstanceId}/actions/backupNodes:
    post:
      description: 'Takes a backup of of given nodes.

        '
      operationId: BackupNode
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request to take node backups
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Takes the backup of given nodes.
      tags:
      - bds
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupNodeDetails'
        description: Details for Taking the node's backup
        required: true
  /bdsInstances/{bdsInstanceId}/actions/changeCompartment:
    post:
      description: 'Moves a Big Data Service cluster into a different compartment.

        '
      operationId: ChangeBdsInstanceCompartment
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The cluster will be moved to another compartment.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Move a Cluster to a Different Compartment
      tags:
      - bds
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeBdsInstanceCompartmentDetails'
        description: Details for the comparment change.
        required: true
  /bdsInstances/{bdsInstanceId}/actions/changeShape:
    post:
      description: 'Changes the size of a cluster by scaling up or scaling down the nodes. Nodes are scaled up or down by changing the shapes of all the nodes of the same type to the next larger or smaller shape. The node types are master, utility, worker, and Cloud SQL. Only nodes with VM-STANDARD shapes can be scaled.

        '
      operationId: ChangeShape
      parameters:
      - $ref: '#/components/parameters/BdsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Request accepted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a request, provide this request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Resize a Cluster by Changing Node Shapes
      tags:
      - bds
      x-related-resource: '#/definitions/BdsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components

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