ClustersApi
All URIs are relative to https://api.ionos.com/databases/postgresql
Method | HTTP request | Description |
---|---|---|
GET /clusters/{clusterId}/postgresversions | List PostgreSQL versions | |
DELETE /clusters/{clusterId} | Delete a cluster | |
GET /clusters/{clusterId} | Fetch a cluster | |
GET /clusters | List clusters | |
PATCH /clusters/{clusterId} | Patch a cluster | |
POST /clusters | Create a cluster | |
GET /clusters/postgresversions | List PostgreSQL versions |
PostgresVersionList clusterPostgresVersionsGet(clusterId)
List PostgreSQL versions
Retrieves a list of all PostgreSQL versions available for this cluster including the current version.
// Import classes:
import com.ionoscloud.dbaaspostgres.ApiClient;
import com.ionoscloud.dbaaspostgres.ApiException;
import com.ionoscloud.dbaaspostgres.Configuration;
import com.ionoscloud.dbaaspostgres.auth.*;
import com.ionoscloud.dbaaspostgres.model.*;
import com.ionoscloud.dbaaspostgres.api.ClustersApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
ClustersApi apiInstance = new ClustersApi(defaultClient);
String clusterId = "498ae72f-411f-11eb-9d07-046c59cc737e"; // String | The unique ID of the cluster.
try {
PostgresVersionList result = apiInstance.clusterPostgresVersionsGet(clusterId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClustersApi#clusterPostgresVersionsGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
Name | Type | Description | Notes |
---|---|---|---|
clusterId | String | The unique ID of the cluster. | |
- Content-Type: Not defined
- Accept: application/json
ClusterResponse clustersDelete(clusterId)
Delete a cluster
Delete a PostgreSQL cluster.
// Import classes:
import com.ionoscloud.dbaaspostgres.ApiClient;
import com.ionoscloud.dbaaspostgres.ApiException;
import com.ionoscloud.dbaaspostgres.Configuration;
import com.ionoscloud.dbaaspostgres.auth.*;
import com.ionoscloud.dbaaspostgres.model.*;
import com.ionoscloud.dbaaspostgres.api.ClustersApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
ClustersApi apiInstance = new ClustersApi(defaultClient);
String clusterId = "498ae72f-411f-11eb-9d07-046c59cc737e"; // String | The unique ID of the cluster.
try {
ClusterResponse result = apiInstance.clustersDelete(clusterId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClustersApi#clustersDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
Name | Type | Description | Notes |
---|---|---|---|
clusterId | String | The unique ID of the cluster. | |
- Content-Type: Not defined
- Accept: application/json
ClusterResponse clustersFindById(clusterId)
Fetch a cluster
You can retrieve a PostgreSQL cluster by using its ID. This value can be found in the response body when a PostgreSQL cluster is created or when you GET a list of PostgreSQL clusters.
// Import classes:
import com.ionoscloud.dbaaspostgres.ApiClient;
import com.ionoscloud.dbaaspostgres.ApiException;
import com.ionoscloud.dbaaspostgres.Configuration;
import com.ionoscloud.dbaaspostgres.auth.*;
import com.ionoscloud.dbaaspostgres.model.*;
import com.ionoscloud.dbaaspostgres.api.ClustersApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
ClustersApi apiInstance = new ClustersApi(defaultClient);
String clusterId = "498ae72f-411f-11eb-9d07-046c59cc737e"; // String | The unique ID of the cluster.
try {
ClusterResponse result = apiInstance.clustersFindById(clusterId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClustersApi#clustersFindById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
Name | Type | Description | Notes |
---|---|---|---|
clusterId | String | The unique ID of the cluster. | |
- Content-Type: Not defined
- Accept: application/json
ClusterList clustersGet(limit, offset, filterName)
List clusters
Retrieves a list of PostgreSQL clusters.
// Import classes:
import com.ionoscloud.dbaaspostgres.ApiClient;
import com.ionoscloud.dbaaspostgres.ApiException;
import com.ionoscloud.dbaaspostgres.Configuration;
import com.ionoscloud.dbaaspostgres.auth.*;
import com.ionoscloud.dbaaspostgres.model.*;
import com.ionoscloud.dbaaspostgres.api.ClustersApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
ClustersApi apiInstance = new ClustersApi(defaultClient);
Integer limit = 100; // Integer | The maximum number of elements to return. Use together with 'offset' for pagination.
Integer offset = 0; // Integer | The first element to return. Use together with 'limit' for pagination.
String filterName = "filterName_example"; // String | Response filter to list only the PostgreSQL clusters that contain the specified name. The value is case insensitive and matched on the 'displayName' field.
try {
ClusterList result = apiInstance.clustersGet(limit, offset, filterName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClustersApi#clustersGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
Name | Type | Description | Notes |
---|---|---|---|
limit | Integer | 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] |
filterName | String | Response filter to list only the PostgreSQL clusters that contain the specified name. The value is case insensitive and matched on the 'displayName' field. | [optional] |
- Content-Type: Not defined
- Accept: application/json
ClusterResponse clustersPatch(clusterId, patchClusterRequest)
Patch a cluster
Patch attributes of a PostgreSQL cluster.
// Import classes:
import com.ionoscloud.dbaaspostgres.ApiClient;
import com.ionoscloud.dbaaspostgres.ApiException;
import com.ionoscloud.dbaaspostgres.Configuration;
import com.ionoscloud.dbaaspostgres.auth.*;
import com.ionoscloud.dbaaspostgres.model.*;
import com.ionoscloud.dbaaspostgres.api.ClustersApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
ClustersApi apiInstance = new ClustersApi(defaultClient);
String clusterId = "498ae72f-411f-11eb-9d07-046c59cc737e"; // String | The unique ID of the cluster.
PatchClusterRequest patchClusterRequest = new PatchClusterRequest(); // PatchClusterRequest | Part of the cluster which should be modified.
try {
ClusterResponse result = apiInstance.clustersPatch(clusterId, patchClusterRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClustersApi#clustersPatch");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
Name | Type | Description | Notes |
---|---|---|---|
clusterId | String | The unique ID of the cluster. | |
patchClusterRequest | Part of the cluster which should be modified. | |
- Content-Type: application/json
- Accept: application/json
ClusterResponse clustersPost(createClusterRequest)
Create a cluster
Creates a new PostgreSQL cluster. If the `fromBackup` field is populated, the new cluster will be created based on the given backup.
// Import classes:
import com.ionoscloud.dbaaspostgres.ApiClient;
import com.ionoscloud.dbaaspostgres.ApiException;
import com.ionoscloud.dbaaspostgres.Configuration;
import com.ionoscloud.dbaaspostgres.auth.*;
import com.ionoscloud.dbaaspostgres.model.*;
import com.ionoscloud.dbaaspostgres.api.ClustersApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
ClustersApi apiInstance = new ClustersApi(defaultClient);
CreateClusterRequest createClusterRequest = new CreateClusterRequest(); // CreateClusterRequest | The cluster to be created.
try {
ClusterResponse result = apiInstance.clustersPost(createClusterRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClustersApi#clustersPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
Name | Type | Description | Notes |
---|---|---|---|
createClusterRequest | The cluster to be created. | |
- Content-Type: application/json
- Accept: application/json
PostgresVersionList postgresVersionsGet()
List PostgreSQL versions
Retrieves a list of all available PostgreSQL versions.
// Import classes:
import com.ionoscloud.dbaaspostgres.ApiClient;
import com.ionoscloud.dbaaspostgres.ApiException;
import com.ionoscloud.dbaaspostgres.Configuration;
import com.ionoscloud.dbaaspostgres.auth.*;
import com.ionoscloud.dbaaspostgres.model.*;
import com.ionoscloud.dbaaspostgres.api.ClustersApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
ClustersApi apiInstance = new ClustersApi(defaultClient);
try {
PostgresVersionList result = apiInstance.postgresVersionsGet();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClustersApi#postgresVersionsGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
Last modified 2mo ago