BdsClient

class oci.bds.BdsClient(config, **kwargs)

API for the Big Data Service. Use this API to build, deploy, and manage fully elastic Big Data Service build on Hadoop, Spark and Data Science distribution, which can be fully integrated with existing enterprise data in Oracle Database and Oracle Applications..

Methods

__init__(config, **kwargs) Creates a new service client
add_auto_scaling_configuration(…) Add autoscaling configuration.
add_block_storage(bds_instance_id, …) Adds storage to existing worker nodes.
add_cloud_sql(bds_instance_id, …) Adds Cloud SQL to your cluster.
add_worker_nodes(bds_instance_id, …) Add worker nodes to an existing cluster.
change_bds_instance_compartment(…) Moves a BDS instance into a different compartment.
change_shape(bds_instance_id, …) Scale-up/down individial nodes (per role type) in the cluster.
create_bds_instance(…) Creates a new BDS instance.
delete_bds_instance(bds_instance_id, **kwargs) Deletes a BDS instance by identifier
get_auto_scaling_configuration(…) Gets information about the specified autoscaling configuration.
get_bds_instance(bds_instance_id, **kwargs) Gets a BDS instance by identifier
get_work_request(work_request_id, **kwargs) Gets the status of the work request with the given ID.
list_auto_scaling_configurations(…) Gets information about the autoscaling configuration.
list_bds_instances(compartment_id, **kwargs) Returns a list of BDS instances.
list_work_request_errors(work_request_id, …) Return a (paginated) list of errors for a given work request.
list_work_request_logs(work_request_id, **kwargs) Return a (paginated) list of logs for a given work request.
list_work_requests(compartment_id, **kwargs) Lists the work requests in a compartment.
remove_auto_scaling_configuration(…) Remove autoscaling configuration.
remove_cloud_sql(bds_instance_id, …) Remove Cloud SQL capability.
restart_node(bds_instance_id, …) Restarts a single node of a BDS instance.
update_auto_scaling_configuration(…) Updates certain fields on the specified autoscaling configuration, such as the name, the threshold value, and whether the autoscaling configuration is enabled.
update_bds_instance(bds_instance_id, …) Update the BDS instance identified by the id
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

add_auto_scaling_configuration(bds_instance_id, add_auto_scaling_configuration_details, **kwargs)

Add autoscaling configuration.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • add_auto_scaling_configuration_details (oci.bds.models.AddAutoScalingConfigurationDetails) – (required) Details for create an autoscaling configuration.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use add_auto_scaling_configuration API.

add_block_storage(bds_instance_id, add_block_storage_details, **kwargs)

Adds storage to existing worker nodes. The same amount of storage will be added to all workers. No change will be made to already attached storage. Block Storage once added cannot be removed.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • add_block_storage_details (oci.bds.models.AddBlockStorageDetails) – (required) Details for the newly added block storage
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use add_block_storage API.

add_cloud_sql(bds_instance_id, add_cloud_sql_details, **kwargs)

Adds Cloud SQL to your cluster. This will add a query server node to the cluster and create cell servers on all your worker nodes.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • add_cloud_sql_details (oci.bds.models.AddCloudSqlDetails) – (required) Details for the Cloud SQL capability
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use add_cloud_sql API.

add_worker_nodes(bds_instance_id, add_worker_nodes_details, **kwargs)

Add worker nodes to an existing cluster. The worker nodes added will be based on an identical shape and have the same amount of attached block storage as other worker nodes in the cluster.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • add_worker_nodes_details (oci.bds.models.AddWorkerNodesDetails) – (required) Details for the newly added nodes
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use add_worker_nodes API.

change_bds_instance_compartment(bds_instance_id, change_bds_instance_compartment_details, **kwargs)

Moves a BDS instance into a different compartment.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • change_bds_instance_compartment_details (oci.bds.models.ChangeBdsInstanceCompartmentDetails) – (required) Details for the comparment change.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_bds_instance_compartment API.

change_shape(bds_instance_id, change_shape_details, **kwargs)

Scale-up/down individial nodes (per role type) in the cluster. Customer can choose arbitrarty VM_STANDARD shape to scale-up/down the instance. Only VM_STANDARD nodes can be re-shaped.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • change_shape_details (oci.bds.models.ChangeShapeDetails) – (required) Individual change shape settings per node group. You can change the shape of master, worker, utility and cloudsql nodes.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_shape API.

create_bds_instance(create_bds_instance_details, **kwargs)

Creates a new BDS instance.

Parameters:
  • create_bds_instance_details (oci.bds.models.CreateBdsInstanceDetails) – (required) Details for the new BDS instace.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_retry_token (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use create_bds_instance API.

delete_bds_instance(bds_instance_id, **kwargs)

Deletes a BDS instance by identifier

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_bds_instance API.

get_auto_scaling_configuration(bds_instance_id, auto_scaling_configuration_id, **kwargs)

Gets information about the specified autoscaling configuration.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • auto_scaling_configuration_id (str) – (required) Unique Oracle-assigned identifier of the autoscaling configuration.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AutoScalingConfiguration

Return type:

Response

Example:

Click here to see an example of how to use get_auto_scaling_configuration API.

get_bds_instance(bds_instance_id, **kwargs)

Gets a BDS instance by identifier

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type BdsInstance

Return type:

Response

Example:

Click here to see an example of how to use get_bds_instance API.

get_work_request(work_request_id, **kwargs)

Gets the status of the work request with the given ID.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_work_request API.

list_auto_scaling_configurations(compartment_id, bds_instance_id, **kwargs)

Gets information about the autoscaling configuration.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • lifecycle_state (str) –

    (optional) The state of the autoscaling configuration.

    Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AutoScalingConfigurationSummary

Return type:

Response

Example:

Click here to see an example of how to use list_auto_scaling_configurations API.

list_bds_instances(compartment_id, **kwargs)

Returns a list of BDS instances.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • lifecycle_state (str) –

    (optional) The state of the BDS instance.

    Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “SUSPENDING”, “SUSPENDED”, “RESUMING”, “DELETING”, “DELETED”, “FAILED”

  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of BdsInstanceSummary

Return type:

Response

Example:

Click here to see an example of how to use list_bds_instances API.

list_work_request_errors(work_request_id, **kwargs)

Return a (paginated) list of errors for a given work request.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkRequestError

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)

Return a (paginated) list of logs for a given work request.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkRequestLogEntry

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)

Lists the work requests in a compartment.

Parameters:
  • compartment_id (str) – (required) The OCID of the compartment.
  • resource_id (str) – (optional) The OCID of the resource.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of items to return.
  • sort_by (str) –

    (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 (str) –

    (optional) The sort order to use, either ‘asc’ or ‘desc’.

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkRequest

Return type:

Response

Example:

Click here to see an example of how to use list_work_requests API.

remove_auto_scaling_configuration(bds_instance_id, auto_scaling_configuration_id, remove_auto_scaling_configuration_details, **kwargs)

Remove autoscaling configuration.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • auto_scaling_configuration_id (str) – (required) Unique Oracle-assigned identifier of the autoscaling configuration.
  • remove_auto_scaling_configuration_details (oci.bds.models.RemoveAutoScalingConfigurationDetails) – (required) Details for the Auto Scaling Configuration
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use remove_auto_scaling_configuration API.

remove_cloud_sql(bds_instance_id, remove_cloud_sql_details, **kwargs)

Remove Cloud SQL capability.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • remove_cloud_sql_details (oci.bds.models.RemoveCloudSqlDetails) – (required) Details for the Cloud SQL capability
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use remove_cloud_sql API.

restart_node(bds_instance_id, restart_node_details, **kwargs)

Restarts a single node of a BDS instance.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • restart_node_details (oci.bds.models.RestartNodeDetails) – (required) Details for restarting the node.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use restart_node API.

update_auto_scaling_configuration(bds_instance_id, auto_scaling_configuration_id, update_auto_scaling_configuration_details, **kwargs)

Updates certain fields on the specified autoscaling configuration, such as the name, the threshold value, and whether the autoscaling configuration is enabled.

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • auto_scaling_configuration_id (str) – (required) Unique Oracle-assigned identifier of the autoscaling configuration.
  • update_auto_scaling_configuration_details (oci.bds.models.UpdateAutoScalingConfigurationDetails) – (required) Details for update an autoscaling configuration.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • if_match (str) – (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 (str) – (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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_auto_scaling_configuration API.

update_bds_instance(bds_instance_id, update_bds_instance_details, **kwargs)

Update the BDS instance identified by the id

Parameters:
  • bds_instance_id (str) – (required) The OCID of the BDS instance
  • update_bds_instance_details (oci.bds.models.UpdateBdsInstanceDetails) – (required) Details for the to-be-updated BDS instace.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_bds_instance API.