ClustersApi
All URIs are relative to https://api.ionos.com/databases/mongodb
ClustersDelete
var result ClusterResponse = ClustersDelete(ctx, clusterId)
.Execute()
Delete a Cluster
Example
package main
import (
"context"
"fmt"
"os"
mongo "github.com/ionos-cloud/sdk-go-bundle/products/dbaas/mongo"
"github.com/ionos-cloud/sdk-go-bundle/shared"
)
func main() {
clusterId := "clusterId_example" // string | The unique ID of the cluster.
configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := mongo.NewAPIClient(configuration)
resource, resp, err := apiClient.ClustersApi.ClustersDelete(context.Background(), clusterId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.ClustersDelete``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `ClustersDelete`: ClusterResponse
fmt.Fprintf(os.Stdout, "Response from `ClustersApi.ClustersDelete`: %v\n", resource)
}
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterId
string
The unique ID of the cluster.
Other Parameters
Other parameters are passed through a pointer to an apiClustersDeleteRequest struct via the builder pattern
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
ClustersFindById
var result ClusterResponse = ClustersFindById(ctx, clusterId)
.Execute()
Get a cluster by id
Example
package main
import (
"context"
"fmt"
"os"
mongo "github.com/ionos-cloud/sdk-go-bundle/products/dbaas/mongo"
"github.com/ionos-cloud/sdk-go-bundle/shared"
)
func main() {
clusterId := "clusterId_example" // string | The unique ID of the cluster.
configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := mongo.NewAPIClient(configuration)
resource, resp, err := apiClient.ClustersApi.ClustersFindById(context.Background(), clusterId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.ClustersFindById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `ClustersFindById`: ClusterResponse
fmt.Fprintf(os.Stdout, "Response from `ClustersApi.ClustersFindById`: %v\n", resource)
}
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterId
string
The unique ID of the cluster.
Other Parameters
Other parameters are passed through a pointer to an apiClustersFindByIdRequest struct via the builder pattern
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
ClustersGet
var result ClusterList = ClustersGet(ctx)
.FilterName(filterName)
.Execute()
Get Clusters
Example
package main
import (
"context"
"fmt"
"os"
mongo "github.com/ionos-cloud/sdk-go-bundle/products/dbaas/mongo"
"github.com/ionos-cloud/sdk-go-bundle/shared"
)
func main() {
filterName := "filterName_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. (optional)
configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := mongo.NewAPIClient(configuration)
resource, resp, err := apiClient.ClustersApi.ClustersGet(context.Background()).FilterName(filterName).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.ClustersGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `ClustersGet`: ClusterList
fmt.Fprintf(os.Stdout, "Response from `ClustersApi.ClustersGet`: %v\n", resource)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to an apiClustersGetRequest struct via the builder pattern
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.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
ClustersPatch
var result ClusterResponse = ClustersPatch(ctx, clusterId)
.PatchClusterRequest(patchClusterRequest)
.Execute()
Patch a cluster
Example
package main
import (
"context"
"fmt"
"os"
mongo "github.com/ionos-cloud/sdk-go-bundle/products/dbaas/mongo"
"github.com/ionos-cloud/sdk-go-bundle/shared"
)
func main() {
clusterId := "clusterId_example" // string | The unique ID of the cluster.
patchClusterRequest := *openapiclient.NewPatchClusterRequest() // PatchClusterRequest | Part of the cluster which should be modified.
configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := mongo.NewAPIClient(configuration)
resource, resp, err := apiClient.ClustersApi.ClustersPatch(context.Background(), clusterId).PatchClusterRequest(patchClusterRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.ClustersPatch``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `ClustersPatch`: ClusterResponse
fmt.Fprintf(os.Stdout, "Response from `ClustersApi.ClustersPatch`: %v\n", resource)
}
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterId
string
The unique ID of the cluster.
Other Parameters
Other parameters are passed through a pointer to an apiClustersPatchRequest struct via the builder pattern
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
ClustersPost
var result ClusterResponse = ClustersPost(ctx)
.CreateClusterRequest(createClusterRequest)
.Execute()
Create a Cluster
Example
package main
import (
"context"
"fmt"
"os"
mongo "github.com/ionos-cloud/sdk-go-bundle/products/dbaas/mongo"
"github.com/ionos-cloud/sdk-go-bundle/shared"
)
func main() {
createClusterRequest := *openapiclient.NewCreateClusterRequest() // CreateClusterRequest | The cluster to be created.
configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := mongo.NewAPIClient(configuration)
resource, resp, err := apiClient.ClustersApi.ClustersPost(context.Background()).CreateClusterRequest(createClusterRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ClustersApi.ClustersPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `ClustersPost`: ClusterResponse
fmt.Fprintf(os.Stdout, "Response from `ClustersApi.ClustersPost`: %v\n", resource)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to an apiClustersPostRequest struct via the builder pattern
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated