# ClustersApi All URIs are relative to ** | Method | HTTP request | Description | | ----------------------------------------- | -------------------------------- | --------------------- | | [**ClustersDelete**](#ClustersDelete) | **Delete** /clusters/{clusterId} | Delete Cluster | | [**ClustersFindById**](#ClustersFindById) | **Get** /clusters/{clusterId} | Retrieve Cluster | | [**ClustersGet**](#ClustersGet) | **Get** /clusters | Retrieve all Clusters | | [**ClustersPost**](#ClustersPost) | **Post** /clusters | Create Cluster | ## ClustersDelete ```go var result = ClustersDelete(ctx, clusterId) .Execute() ``` Delete Cluster ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go-kafka" ) func main() { clusterId := "e69b22a5-8fee-56b1-b6fb-4a07e4205ead" // string | The ID (UUID) of the Cluster. configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL") apiClient := ionoscloud.NewAPIClient(configuration) 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) } } ``` ### Path Parameters | Name | Type | Description | Notes | | ------------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **clusterId** | **string** | The ID (UUID) of the Cluster. | | ### Other Parameters Other parameters are passed through a pointer to an apiClustersDeleteRequest struct via the builder pattern ### Return type (empty response body) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ### URLs Configuration per Operation Each operation can use different server URL defined using `OperationServers` map in the `Configuration`. An operation is uniquely identified by `"ClustersApiService.ClustersDelete"` string. Similar rules for overriding default operation server index and variables apply by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps. ```golang ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{ "ClustersApiService.ClustersDelete": 2, }) ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{ "ClustersApiService.ClustersDelete": { "port": "8443", }, }) ``` ## ClustersFindById ```go var result ClusterRead = ClustersFindById(ctx, clusterId) .Execute() ``` Retrieve Cluster ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go-kafka" ) func main() { clusterId := "e69b22a5-8fee-56b1-b6fb-4a07e4205ead" // string | The ID (UUID) of the Cluster. configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL") apiClient := ionoscloud.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`: ClusterRead fmt.Fprintf(os.Stdout, "Response from `ClustersApi.ClustersFindById`: %v\n", resource) } ``` ### Path Parameters | Name | Type | Description | Notes | | ------------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **clusterId** | **string** | The ID (UUID) of the Cluster. | | ### Other Parameters Other parameters are passed through a pointer to an apiClustersFindByIdRequest struct via the builder pattern ### Return type [**ClusterRead**](/kafka-sdk-golang/models/clusterread.md) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ### URLs Configuration per Operation Each operation can use different server URL defined using `OperationServers` map in the `Configuration`. An operation is uniquely identified by `"ClustersApiService.ClustersFindById"` string. Similar rules for overriding default operation server index and variables apply by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps. ```golang ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{ "ClustersApiService.ClustersFindById": 2, }) ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{ "ClustersApiService.ClustersFindById": { "port": "8443", }, }) ``` ## ClustersGet ```go var result ClusterReadList = ClustersGet(ctx) .FilterName(filterName) .FilterState(filterState) .Execute() ``` Retrieve all Clusters ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go-kafka" ) func main() { filterName := "filterName_example" // string | Only return Kafka clusters that contain the given name. Case insensitive. (optional) filterState := "filterState_example" // string | Only return Kafka clusters with a given state. (optional) configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL") apiClient := ionoscloud.NewAPIClient(configuration) resource, resp, err := apiClient.ClustersApi.ClustersGet(context.Background()).FilterName(filterName).FilterState(filterState).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`: ClusterReadList 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 | Name | Type | Description | Notes | | --------------- | ---------- | ------------------------------------------------------------------------- | ----- | | **filterName** | **string** | Only return Kafka clusters that contain the given name. Case insensitive. | | | **filterState** | **string** | Only return Kafka clusters with a given state. | | ### Return type [**ClusterReadList**](/kafka-sdk-golang/models/clusterreadlist.md) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ### URLs Configuration per Operation Each operation can use different server URL defined using `OperationServers` map in the `Configuration`. An operation is uniquely identified by `"ClustersApiService.ClustersGet"` string. Similar rules for overriding default operation server index and variables apply by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps. ```golang ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{ "ClustersApiService.ClustersGet": 2, }) ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{ "ClustersApiService.ClustersGet": { "port": "8443", }, }) ``` ## ClustersPost ```go var result ClusterRead = ClustersPost(ctx) .ClusterCreate(clusterCreate) .Execute() ``` Create Cluster ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go-kafka" ) func main() { clusterCreate := *openapiclient.NewClusterCreate(*openapiclient.NewCluster("my-kafka-cluster", "3.7.0", "XS", []openapiclient.KafkaClusterConnection{*openapiclient.NewKafkaClusterConnection("5a029f4a-72e5-11ec-90d6-0242ac120003", "2", []string{"192.168.1.101/24"})})) // ClusterCreate | Cluster to create. configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL") apiClient := ionoscloud.NewAPIClient(configuration) resource, resp, err := apiClient.ClustersApi.ClustersPost(context.Background()).ClusterCreate(clusterCreate).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`: ClusterRead 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 | Name | Type | Description | Notes | | ----------------- | -------------------------------------------------------------- | ------------------ | ----- | | **clusterCreate** | [**ClusterCreate**](/kafka-sdk-golang/models/clustercreate.md) | Cluster to create. | | ### Return type [**ClusterRead**](/kafka-sdk-golang/models/clusterread.md) ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ### URLs Configuration per Operation Each operation can use different server URL defined using `OperationServers` map in the `Configuration`. An operation is uniquely identified by `"ClustersApiService.ClustersPost"` string. Similar rules for overriding default operation server index and variables apply by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps. ```golang ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{ "ClustersApiService.ClustersPost": 2, }) ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{ "ClustersApiService.ClustersPost": { "port": "8443", }, }) ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ionos.com/kafka-sdk-golang/api/clustersapi.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.