BDS Functions

Package: DBMS_CLOUD_OCI_BDS_BDS

ACTIVATE_BDS_METASTORE_CONFIGURATION Function

Activate specified metastore configuration.

Syntax

FUNCTION activate_bds_metastore_configuration (
  bds_instance_id varchar2,
  metastore_config_id varchar2,
  activate_bds_metastore_configuration_details dbms_cloud_oci_bds_activate_bds_metastore_configuration_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_activate_bds_metastore_configuration_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`metastore_config_id`	(required) The metastore configuration ID
`activate_bds_metastore_configuration_details`	(required) The request body when activating specified metastore configuration.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_AUTO_SCALING_CONFIGURATION Function

Add an autoscale configuration to the cluster.

Syntax

FUNCTION add_auto_scaling_configuration (
  bds_instance_id varchar2,
  add_auto_scaling_configuration_details dbms_cloud_oci_bds_add_auto_scaling_configuration_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_add_auto_scaling_configuration_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`add_auto_scaling_configuration_details`	(required) Details for creating an autoscale configuration.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_BLOCK_STORAGE Function

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.

Syntax

FUNCTION add_block_storage (
  bds_instance_id varchar2,
  add_block_storage_details dbms_cloud_oci_bds_add_block_storage_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_add_block_storage_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`add_block_storage_details`	(required) Details for the added block storage.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_CLOUD_SQL Function

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.

Syntax

FUNCTION add_cloud_sql (
  bds_instance_id varchar2,
  add_cloud_sql_details dbms_cloud_oci_bds_add_cloud_sql_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_add_cloud_sql_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`add_cloud_sql_details`	(required) Details for the Cloud SQL capability
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_KAFKA Function

Adds Kafka to a cluster.

Syntax

FUNCTION add_kafka (
  bds_instance_id varchar2,
  add_kafka_details dbms_cloud_oci_bds_add_kafka_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_add_kafka_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`add_kafka_details`	(required) Details of the Kafka broker nodes to employ to enable the service.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_MASTER_NODES Function

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.

Syntax

FUNCTION add_master_nodes (
  bds_instance_id varchar2,
  add_master_nodes_details dbms_cloud_oci_bds_add_master_nodes_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_add_master_nodes_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`add_master_nodes_details`	(required) Details for the newly added nodes.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_UTILITY_NODES Function

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.

Syntax

FUNCTION add_utility_nodes (
  bds_instance_id varchar2,
  add_utility_nodes_details dbms_cloud_oci_bds_add_utility_nodes_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_add_utility_nodes_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`add_utility_nodes_details`	(required) Details for the newly added nodes.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_WORKER_NODES Function

Increases the size (scales out) a cluster by adding worker nodes(data/compute). The added worker nodes will have the same shape and will have the same amount of attached block storage as other worker nodes in the cluster.

Syntax

FUNCTION add_worker_nodes (
  bds_instance_id varchar2,
  add_worker_nodes_details dbms_cloud_oci_bds_add_worker_nodes_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_add_worker_nodes_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`add_worker_nodes_details`	(required) Details for the newly added nodes.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CERTIFICATE_SERVICE_INFO Function

A list of services and their certificate details.

Syntax

FUNCTION certificate_service_info (
  bds_instance_id varchar2,
  certificate_service_info_details dbms_cloud_oci_bds_certificate_service_info_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_certificate_service_info_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`certificate_service_info_details`	(required) Details for certificate service info
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_BDS_INSTANCE_COMPARTMENT Function

Moves a Big Data Service cluster into a different compartment.

Syntax

FUNCTION change_bds_instance_compartment (
  bds_instance_id varchar2,
  change_bds_instance_compartment_details dbms_cloud_oci_bds_change_bds_instance_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_change_bds_instance_compartment_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`change_bds_instance_compartment_details`	(required) Details for the comparment change.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SHAPE Function

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.

Syntax

FUNCTION change_shape (
  bds_instance_id varchar2,
  change_shape_details dbms_cloud_oci_bds_change_shape_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_change_shape_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`change_shape_details`	(required) Individual change shape settings per node type. You can change the shape of master, worker, utility and Cloud SQL nodes.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BDS_API_KEY Function

Create an API key on behalf of the specified user.

Syntax

FUNCTION create_bds_api_key (
  bds_instance_id varchar2,
  create_bds_api_key_details dbms_cloud_oci_bds_create_bds_api_key_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_create_bds_api_key_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`create_bds_api_key_details`	(required) Create a new user's API key.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BDS_INSTANCE Function

Creates a Big Data Service cluster.

Syntax

FUNCTION create_bds_instance (
  create_bds_instance_details dbms_cloud_oci_bds_create_bds_instance_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_create_bds_instance_response_t;

Parameters

Parameter	Description
`create_bds_instance_details`	(required) Details for the new cluster.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BDS_METASTORE_CONFIGURATION Function

Create and activate external metastore configuration.

Syntax

FUNCTION create_bds_metastore_configuration (
  bds_instance_id varchar2,
  create_bds_metastore_configuration_details dbms_cloud_oci_bds_create_bds_metastore_configuration_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_create_bds_metastore_configuration_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`create_bds_metastore_configuration_details`	(required) The request body when creating and activating external metastore configuration.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BDS_API_KEY Function

Deletes the user's API key represented by the provided ID.

Syntax

FUNCTION delete_bds_api_key (
  bds_instance_id varchar2,
  api_key_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_delete_bds_api_key_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`api_key_id`	(required) The API key identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BDS_INSTANCE Function

Deletes the cluster identified by the given ID.

Syntax

FUNCTION delete_bds_instance (
  bds_instance_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_delete_bds_instance_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BDS_METASTORE_CONFIGURATION Function

Delete the BDS metastore configuration represented by the provided ID.

Syntax

FUNCTION delete_bds_metastore_configuration (
  bds_instance_id varchar2,
  metastore_config_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_delete_bds_metastore_configuration_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`metastore_config_id`	(required) The metastore configuration ID
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DISABLE_CERTIFICATE Function

Disabling TLS/SSL for various ODH services running on the BDS cluster.

Syntax

FUNCTION disable_certificate (
  bds_instance_id varchar2,
  disable_certificate_details dbms_cloud_oci_bds_disable_certificate_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_disable_certificate_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`disable_certificate_details`	(required) Details for disabling certificate.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ENABLE_CERTIFICATE Function

Configuring TLS/SSL for various ODH services running on the BDS cluster.

Syntax

FUNCTION enable_certificate (
  bds_instance_id varchar2,
  enable_certificate_details dbms_cloud_oci_bds_enable_certificate_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_enable_certificate_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`enable_certificate_details`	(required) Details for configuring certificate.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

EXECUTE_BOOTSTRAP_SCRIPT Function

Execute bootstrap script.

Syntax

FUNCTION execute_bootstrap_script (
  bds_instance_id varchar2,
  execute_bootstrap_script_details dbms_cloud_oci_bds_execute_bootstrap_script_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_execute_bootstrap_script_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`execute_bootstrap_script_details`	(required) Details of the bootstrap script to execute on this cluster.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_AUTO_SCALING_CONFIGURATION Function

Returns details of the autoscale configuration identified by the given ID.

Syntax

FUNCTION get_auto_scaling_configuration (
  bds_instance_id varchar2,
  auto_scaling_configuration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_get_auto_scaling_configuration_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`auto_scaling_configuration_id`	(required) Unique Oracle-assigned identifier of the autoscale configuration.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BDS_API_KEY Function

Returns the user's API key information for the given ID.

Syntax

FUNCTION get_bds_api_key (
  bds_instance_id varchar2,
  api_key_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_get_bds_api_key_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`api_key_id`	(required) The API key identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BDS_INSTANCE Function

Returns information about the Big Data Service cluster identified by the given ID.

Syntax

FUNCTION get_bds_instance (
  bds_instance_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_get_bds_instance_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BDS_METASTORE_CONFIGURATION Function

Returns the BDS Metastore configuration information for the given ID.

Syntax

FUNCTION get_bds_metastore_configuration (
  bds_instance_id varchar2,
  metastore_config_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_get_bds_metastore_configuration_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`metastore_config_id`	(required) The metastore configuration ID
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_OS_PATCH_DETAILS Function

Get the details of an os patch

Syntax

FUNCTION get_os_patch_details (
  bds_instance_id varchar2,
  os_patch_version varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_get_os_patch_details_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`os_patch_version`	(required) The version of the OS patch.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Returns the status of the work request identified by the given ID.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

INSTALL_OS_PATCH Function

Install an os patch on a cluster

Syntax

FUNCTION install_os_patch (
  bds_instance_id varchar2,
  install_os_patch_details dbms_cloud_oci_bds_install_os_patch_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_install_os_patch_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`install_os_patch_details`	(required) Details of the target os patch that will be installed
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

INSTALL_PATCH Function

Install the specified patch to this cluster.

Syntax

FUNCTION install_patch (
  bds_instance_id varchar2,
  install_patch_details dbms_cloud_oci_bds_install_patch_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_install_patch_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`install_patch_details`	(required) Details of the patch to be installed.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AUTO_SCALING_CONFIGURATIONS Function

Returns information about the autoscaling configurations for a cluster.

Syntax

FUNCTION list_auto_scaling_configurations (
  compartment_id varchar2,
  bds_instance_id varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_list_auto_scaling_configurations_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`bds_instance_id`	(required) The OCID of the cluster.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`lifecycle_state`	(optional) The state of the autoscale configuration.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BDS_API_KEYS Function

Returns a list of all API keys associated with this Big Data Service cluster.

Syntax

FUNCTION list_bds_api_keys (
  bds_instance_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  user_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_list_bds_api_keys_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`lifecycle_state`	(optional) The state of the API key.
`user_id`	(optional) The OCID of the user for whom the API key belongs.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BDS_INSTANCES Function

Returns a list of all Big Data Service clusters in a compartment.

Syntax

FUNCTION list_bds_instances (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_list_bds_instances_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`lifecycle_state`	(optional) The state of the cluster.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BDS_METASTORE_CONFIGURATIONS Function

Returns a list of metastore configurations ssociated with this Big Data Service cluster.

Syntax

FUNCTION list_bds_metastore_configurations (
  bds_instance_id varchar2,
  metastore_type varchar2 DEFAULT NULL,
  metastore_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  bds_api_key_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_list_bds_metastore_configurations_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`metastore_type`	(optional) The type of the metastore in the metastore configuration
`metastore_id`	(optional) The OCID of the Data Catalog metastore in the metastore configuration
`lifecycle_state`	(optional) The lifecycle state of the metastore in the metastore configuration
`bds_api_key_id`	(optional) The ID of the API key that is associated with the external metastore in the metastore configuration
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_OS_PATCHES Function

List all available os patches for a given cluster

Syntax

FUNCTION list_os_patches (
  bds_instance_id varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_list_os_patches_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PATCH_HISTORIES Function

List the patch history of this cluster.

Syntax

FUNCTION list_patch_histories (
  bds_instance_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  patch_version varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  patch_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_list_patch_histories_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`opc_request_id`	(optional) The client request ID for tracing.
`lifecycle_state`	(optional) The status of the patch.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`patch_version`	(optional) The version of the patch
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`patch_type`	(optional) The type of a BDS patch history entity.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PATCHES Function

List all the available patches for this cluster.

Syntax

FUNCTION list_patches (
  bds_instance_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_list_patches_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Returns a paginated list of errors for a work request identified by the given ID.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Returns a paginated list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  resource_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`resource_id`	(optional) The OCID of the resource.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_AUTO_SCALING_CONFIGURATION Function

Deletes an autoscale configuration.

Syntax

FUNCTION remove_auto_scaling_configuration (
  bds_instance_id varchar2,
  auto_scaling_configuration_id varchar2,
  remove_auto_scaling_configuration_details dbms_cloud_oci_bds_remove_auto_scaling_configuration_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_remove_auto_scaling_configuration_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`auto_scaling_configuration_id`	(required) Unique Oracle-assigned identifier of the autoscale configuration.
`remove_auto_scaling_configuration_details`	(required) Details for the autoscale configuration
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_CLOUD_SQL Function

Removes Cloud SQL from the cluster.

Syntax

FUNCTION remove_cloud_sql (
  bds_instance_id varchar2,
  remove_cloud_sql_details dbms_cloud_oci_bds_remove_cloud_sql_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_remove_cloud_sql_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`remove_cloud_sql_details`	(required) Details for the Cloud SQL capability
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_KAFKA Function

Remove Kafka from the cluster.

Syntax

FUNCTION remove_kafka (
  bds_instance_id varchar2,
  remove_kafka_details dbms_cloud_oci_bds_remove_kafka_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_remove_kafka_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`remove_kafka_details`	(required) Details for the Kafka capability.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_NODE Function

Remove a single node of a Big Data Service cluster

Syntax

FUNCTION remove_node (
  bds_instance_id varchar2,
  remove_node_details dbms_cloud_oci_bds_remove_node_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_remove_node_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`remove_node_details`	(required) Details for the node to be removed.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RENEW_CERTIFICATE Function

Renewing TLS/SSL for various ODH services running on the BDS cluster.

Syntax

FUNCTION renew_certificate (
  bds_instance_id varchar2,
  renew_certificate_details dbms_cloud_oci_bds_renew_certificate_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_renew_certificate_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`renew_certificate_details`	(required) Details for renewing certificate.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RESTART_NODE Function

Restarts a single node of a Big Data Service cluster

Syntax

FUNCTION restart_node (
  bds_instance_id varchar2,
  restart_node_details dbms_cloud_oci_bds_restart_node_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_restart_node_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`restart_node_details`	(required) Details for restarting the node.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

START_BDS_INSTANCE Function

Starts the BDS cluster that was stopped earlier.

Syntax

FUNCTION start_bds_instance (
  bds_instance_id varchar2,
  start_bds_instance_details dbms_cloud_oci_bds_start_bds_instance_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_start_bds_instance_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`start_bds_instance_details`	(required) Parameters for starting a cluster
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

STOP_BDS_INSTANCE Function

Stops the BDS cluster that can be started at later point of time.

Syntax

FUNCTION stop_bds_instance (
  bds_instance_id varchar2,
  stop_bds_instance_details dbms_cloud_oci_bds_stop_bds_instance_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_stop_bds_instance_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`stop_bds_instance_details`	(required) Parameters for stopping a cluster
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

TEST_BDS_METASTORE_CONFIGURATION Function

Test specified metastore configuration.

Syntax

FUNCTION test_bds_metastore_configuration (
  bds_instance_id varchar2,
  metastore_config_id varchar2,
  test_bds_metastore_configuration_details dbms_cloud_oci_bds_test_bds_metastore_configuration_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_test_bds_metastore_configuration_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`metastore_config_id`	(required) The metastore configuration ID
`test_bds_metastore_configuration_details`	(required) Request body for testing BDS metastore configuration.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

TEST_BDS_OBJECT_STORAGE_CONNECTION Function

Test access to specified Object Storage bucket using the API key.

Syntax

FUNCTION test_bds_object_storage_connection (
  bds_instance_id varchar2,
  api_key_id varchar2,
  test_bds_object_storage_connection_details dbms_cloud_oci_bds_test_bds_object_storage_connection_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_test_bds_object_storage_connection_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`api_key_id`	(required) The API key identifier.
`test_bds_object_storage_connection_details`	(required) Parameters required to validate access to the specified Object Storage bucket using the API key.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_AUTO_SCALING_CONFIGURATION Function

Updates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale configuration is enabled.

Syntax

FUNCTION update_auto_scaling_configuration (
  bds_instance_id varchar2,
  auto_scaling_configuration_id varchar2,
  update_auto_scaling_configuration_details dbms_cloud_oci_bds_update_auto_scaling_configuration_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_update_auto_scaling_configuration_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`auto_scaling_configuration_id`	(required) Unique Oracle-assigned identifier of the autoscale configuration.
`update_auto_scaling_configuration_details`	(required) Details for update an autoscaling configuration.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BDS_INSTANCE Function

Updates the Big Data Service cluster identified by the given ID.

Syntax

FUNCTION update_bds_instance (
  bds_instance_id varchar2,
  update_bds_instance_details dbms_cloud_oci_bds_update_bds_instance_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_update_bds_instance_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`update_bds_instance_details`	(required) Details for the cluster to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BDS_METASTORE_CONFIGURATION Function

Update the BDS metastore configuration represented by the provided ID.

Syntax

FUNCTION update_bds_metastore_configuration (
  bds_instance_id varchar2,
  metastore_config_id varchar2,
  update_bds_metastore_configuration_details dbms_cloud_oci_bds_update_bds_metastore_configuration_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_bds_bds_update_bds_metastore_configuration_response_t;

Parameters

Parameter	Description
`bds_instance_id`	(required) The OCID of the cluster.
`metastore_config_id`	(required) The metastore configuration ID
`update_bds_metastore_configuration_details`	(required) Request body for updating BDS metastore configuration.
`opc_request_id`	(optional) The client request ID for tracing.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://bigdataservice.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation

BDS Functions

ACTIVATE_BDS_METASTORE_CONFIGURATION Function

ADD_AUTO_SCALING_CONFIGURATION Function

ADD_BLOCK_STORAGE Function

ADD_CLOUD_SQL Function

ADD_KAFKA Function

ADD_MASTER_NODES Function

ADD_UTILITY_NODES Function

ADD_WORKER_NODES Function

CERTIFICATE_SERVICE_INFO Function

CHANGE_BDS_INSTANCE_COMPARTMENT Function

CHANGE_SHAPE Function

CREATE_BDS_API_KEY Function

CREATE_BDS_INSTANCE Function

CREATE_BDS_METASTORE_CONFIGURATION Function

DELETE_BDS_API_KEY Function

DELETE_BDS_INSTANCE Function

DELETE_BDS_METASTORE_CONFIGURATION Function

DISABLE_CERTIFICATE Function

ENABLE_CERTIFICATE Function

EXECUTE_BOOTSTRAP_SCRIPT Function

GET_AUTO_SCALING_CONFIGURATION Function

GET_BDS_API_KEY Function

GET_BDS_INSTANCE Function

GET_BDS_METASTORE_CONFIGURATION Function

GET_OS_PATCH_DETAILS Function

GET_WORK_REQUEST Function

INSTALL_OS_PATCH Function

INSTALL_PATCH Function

LIST_AUTO_SCALING_CONFIGURATIONS Function

LIST_BDS_API_KEYS Function

LIST_BDS_INSTANCES Function

LIST_BDS_METASTORE_CONFIGURATIONS Function

LIST_OS_PATCHES Function

LIST_PATCH_HISTORIES Function

LIST_PATCHES Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

REMOVE_AUTO_SCALING_CONFIGURATION Function

REMOVE_CLOUD_SQL Function

REMOVE_KAFKA Function

REMOVE_NODE Function

RENEW_CERTIFICATE Function

RESTART_NODE Function

START_BDS_INSTANCE Function

STOP_BDS_INSTANCE Function

TEST_BDS_METASTORE_CONFIGURATION Function

TEST_BDS_OBJECT_STORAGE_CONNECTION Function

UPDATE_AUTO_SCALING_CONFIGURATION Function

UPDATE_BDS_INSTANCE Function

UPDATE_BDS_METASTORE_CONFIGURATION Function