ClustersApi
All URIs are relative to https://api.ionos.com/databases/mongodb
clustersDelete
clustersDelete(clusterId)
Delete a Cluster
Deletes a MongoDB cluster.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-mongo');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ClustersApi(config);
// Delete a Cluster
api_instance
.clustersDelete({
clusterId: clusterId_example
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Parameters
clusterId
string
The unique ID of the cluster.
[default to undefined]
Return type
Authorization
basicAuth, tokenAuth
HTTP request headers
Content-Type: Not defined
Accept: application/json
clustersFindById
clustersFindById(clusterId)
Get a cluster by id
Get a cluster by id.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-mongo');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ClustersApi(config);
// Get a cluster by id
api_instance
.clustersFindById({
clusterId: clusterId_example
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Parameters
clusterId
string
The unique ID of the cluster.
[default to undefined]
Return type
Authorization
basicAuth, tokenAuth
HTTP request headers
Content-Type: Not defined
Accept: application/json
clustersGet
clustersGet(opts)
Get Clusters
Retrieves a list of MongoDB clusters.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-mongo');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ClustersApi(config);
// Get Clusters
api_instance
.clustersGet({
limit: 100,
offset: 200,
filterName: filterName_example
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Parameters
limit
number
The maximum number of elements to return. Use together with 'offset' for pagination.
[optional][default to 100]
offset
number
The first element to return. Use together with 'limit' for pagination.
[optional][default to 0]
filterName
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.
[optional][default to undefined]
Return type
Authorization
basicAuth, tokenAuth
HTTP request headers
Content-Type: Not defined
Accept: application/json
clustersPatch
clustersPatch(clusterId, patchClusterRequest)
Patch a cluster
Patch attributes of a MongoDB cluster.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-mongo');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ClustersApi(config);
// Patch a cluster
api_instance
.clustersPatch({
clusterId: clusterId_example,
patchClusterRequest: patchClusterRequest_example
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Parameters
clusterId
string
The unique ID of the cluster.
[default to undefined]
Return type
Authorization
basicAuth, tokenAuth
HTTP request headers
Content-Type: application/json
Accept: application/json
clustersPost
clustersPost(createClusterRequest)
Create a Cluster
Creates a new MongoDB cluster.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs-dbaas-mongo');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ClustersApi(config);
// Create a Cluster
api_instance
.clustersPost({
createClusterRequest: createClusterRequest_example
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Parameters
Return type
Authorization
basicAuth, tokenAuth
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated