All URIs are relative to https://api.ionos.com/databases/mongodb
clusters_delete
clusters_delete(cluster_id)
Delete a Cluster
Deletes a MongoDB cluster.
Examples
require'time'require'ionoscloud-dbaas-mongo'# setup authorizationIonoscloudDbaasMongo.configure do|config|# Configure HTTP basic authorization: basicAuth config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: tokenAuth config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =IonoscloudDbaasMongo::ClustersApi.newcluster_id ='cluster_id_example'# String | The unique ID of the cluster.begin# Delete a Cluster result = api_instance.clusters_delete(cluster_id)p resultrescueIonoscloudDbaasMongo::ApiError=> eputs"Error when calling ClustersApi->clusters_delete: #{e}"end
Using the clusters_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
require'time'require'ionoscloud-dbaas-mongo'# setup authorizationIonoscloudDbaasMongo.configure do|config|# Configure HTTP basic authorization: basicAuth config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: tokenAuth config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =IonoscloudDbaasMongo::ClustersApi.newcluster_id ='cluster_id_example'# String | The unique ID of the cluster.begin# Get a cluster by id result = api_instance.clusters_find_by_id(cluster_id)p resultrescueIonoscloudDbaasMongo::ApiError=> eputs"Error when calling ClustersApi->clusters_find_by_id: #{e}"end
Using the clusters_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# Get a cluster by id data, status_code, headers = api_instance.clusters_find_by_id_with_http_info(cluster_id)p status_code # => 2xxp headers # => { ... }p data # => <ClusterResponse>rescueIonoscloudDbaasMongo::ApiError=> eputs"Error when calling ClustersApi->clusters_find_by_id_with_http_info: #{e}"end
require'time'require'ionoscloud-dbaas-mongo'# setup authorizationIonoscloudDbaasMongo.configure do|config|# Configure HTTP basic authorization: basicAuth config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: tokenAuth config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =IonoscloudDbaasMongo::ClustersApi.newopts = { limit: 100,# Integer | The maximum number of elements to return. Use together with 'offset' for pagination. offset: 200,# Integer | The first element to return. Use together with 'limit' for pagination. filter_name: 'filter_name_example' # String | Response filter to list only the MongoDB clusters that contain the specified name. The value is case insensitive and matched on the 'displayName' field.
}begin# Get Clusters result = api_instance.clusters_get(opts)p resultrescueIonoscloudDbaasMongo::ApiError=> eputs"Error when calling ClustersApi->clusters_get: #{e}"end
Using the clusters_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
require'time'require'ionoscloud-dbaas-mongo'# setup authorizationIonoscloudDbaasMongo.configure do|config|# Configure HTTP basic authorization: basicAuth config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: tokenAuth config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =IonoscloudDbaasMongo::ClustersApi.newcluster_id ='cluster_id_example'# String | The unique ID of the cluster.patch_cluster_request = IonoscloudDbaasMongo::PatchClusterRequest.new # PatchClusterRequest | Part of the cluster which should be modified.
begin# Patch a cluster result = api_instance.clusters_patch(cluster_id, patch_cluster_request)p resultrescueIonoscloudDbaasMongo::ApiError=> eputs"Error when calling ClustersApi->clusters_patch: #{e}"end
Using the clusters_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
require'time'require'ionoscloud-dbaas-mongo'# setup authorizationIonoscloudDbaasMongo.configure do|config|# Configure HTTP basic authorization: basicAuth config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: tokenAuth config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =IonoscloudDbaasMongo::ClustersApi.newcreate_cluster_request = IonoscloudDbaasMongo::CreateClusterRequest.new # CreateClusterRequest | The cluster to be created.
begin# Create a Cluster result = api_instance.clusters_post(create_cluster_request)p resultrescueIonoscloudDbaasMongo::ApiError=> eputs"Error when calling ClustersApi->clusters_post: #{e}"end
Using the clusters_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
The maximum number of elements to return. Use together with 'offset' for pagination.
[optional][default to 100]
offset
Integer
The first element to return. Use together with 'limit' for pagination.
[optional][default to 0]
filter_name
String
Response filter to list only the MongoDB clusters that contain the specified name. The value is case insensitive and matched on the 'displayName' field.