---
title: "Cluster"
description: "Explore our Cluster API with comprehensive guides on data store objects, properties, and methods for streamlined development. (Gitana 4.0)"
product: "Gitana"
version: "4.0"
url: "/documentation/gitana/4.0/reference/types/cluster"
---

# <a id="top"></a>Cluster

A Data Store

##### Table of Contents

- [Overview](#top "Overview")
- [Objects](#objects "Objects")
- [Properties](#properties "Properties")
- [Methods](#methods "Methods")
- [Schema](#schema "Schema")

> **Note:** Drop in one of our language drivers to accelerate your development.  
> Here are links to some of our popular [Cookbooks](/documentation/gitana/4.0/developers/cookbooks/overview.md) to help you get started!
> 
> - [C#](/documentation/gitana/4.0/developers/cookbooks/csharp.md)
> - [Go](/documentation/gitana/4.0/developers/cookbooks/go.md)
> - [Java](/documentation/gitana/4.0/developers/cookbooks/java.md)
> - [JavaScript](/documentation/gitana/4.0/developers/cookbooks/javascript2.md)
> - [PHP](/documentation/gitana/4.0/developers/cookbooks/php.md)
> - [Python](/documentation/gitana/4.0/developers/cookbooks/python.md)
> - [Ruby](/documentation/gitana/4.0/developers/cookbooks/ruby.md)

## <a id="objects"></a>Objects

This Cluster contains the following objects:

- [Teamable Hierarchy](/documentation/gitana/4.0/reference/types/teamableHierarchy.md)
- [Access Token](/documentation/gitana/4.0/reference/types/accessToken.md)
- [Server](/documentation/gitana/4.0/reference/types/server.md)
- [Token](/documentation/gitana/4.0/reference/types/token.md)
- [Refresh Token](/documentation/gitana/4.0/reference/types/refreshToken.md)

## <a id="properties"></a>Properties

The following properties are available:

| Property | Type | Default | Read-Only | Description |
| --- | --- | --- | --- | --- |
| \_doc | string |  | No | The primary ID |
| \_system | object |  | No | Metadata maintained by the system |
| binaryStorageProviderType | string |  | No | The type identifier for the binary storage provider that backs this data store |
| datastoreId | string |  | Yes | The ID of the data store |
| datastoreTypeId | string |  | Yes | The data store type identifier |
| defaultDomainId | string |  | No |  |
| description | string |  | No | A description of the data store |
| enableAuthorities | boolean | true | No | Whether to check access control rights for principals against this data store |
| key | string |  | No |  |
| locked | boolean |  | Yes | Whether the data store is presently locked. If the data store is locked, then write operations against it will block. |
| lockedBy | string |  | No | The principal that holds the lock (if the data store is locked) |
| maxsize | number |  | No | The maximum allowed allocation size (on disk) of the data store in bytes. If this size of the data store exceeds this value, write operations will fail. A value of -1 indicates that there is no upper limit. |
| objectcount | number |  | No | The number of objects stored within the data store. This includes system-maintained objects. This value is updated periodically and may not be precise at the moment it is read. |
| size | number |  | Yes | The last-recorded allocation size (on disk) of the data store in bytes. This value is updated periodically and may not be precise at the moment it is read. |
| statisticsDate | object |  | No | Records the time when statistics were last run against the data store. Statistics are run periodically to calculate the data store size and object allocations. |
| statisticsDirty | boolean |  | Yes | Whether writes have occurred against this data store since the last time statistics were run. This signals to the system that statistics need to be collected at the next available opportunity. |
| title | string |  | No | The title of the data store |

## <a id="methods"></a>Methods

The following methods are available:

- [Batches Job](#get-cluster-job-batches "Batches Job")
- [Config Job](#get-cluster-job-config "Config Job")
- [Configuration Cluster](#get-cluster-configuration "Configuration Cluster")
- [Invalidate Replicatedreadonly](#post-cluster-replicatedreadonly-invalidate "Invalidate Replicatedreadonly")
- [Jobqueue Cluster](#get-cluster-jobqueue "Jobqueue Cluster")
- [Jobtree Report](#post-cluster-job-report-jobtree "Jobtree Report")
- [Kill Instance](#post-cluster-job-instances-jobid-kill "Kill Instance")
- [Kill Job](#post-cluster-jobs-jobid-kill "Kill Job")
- [Killall Jobs](#post-cluster-jobs-killall "Killall Jobs")
- [List Dependencies](#get-cluster-jobs-jobid-dependencies "List Dependencies")
- [Modify Configuration](#post-cluster-configuration-modify "Modify Configuration")
- [Query](#post-cluster-job-instances-query "Query")
- [Query](#post-cluster-job-batches-query "Query")
- [Query](#post-cluster-job-queues-query "Query")
- [Query](#post-cluster-jobs-query "Query")
- [Queues Job](#get-cluster-job-queues "Queues Job")
- [Read Batche](#get-cluster-job-batches-batchid "Read Batche")
- [Read Cluster](#get-cluster "Read Cluster")
- [Read Dependson Job](#get-cluster-jobs-jobid-dependson "Read Dependson Job")
- [Read Instance](#get-cluster-job-instances-jobid "Read Instance")
- [Read Job](#get-cluster-jobs-jobid "Read Job")
- [Read Queue](#get-cluster-job-queues-queueid "Read Queue")
- [Read Server](#get-cluster-servers-serverid "Read Server")
- [Running Jobs](#get-cluster-servers-serverid-jobs-running "Running Jobs")
- [Running Report](#post-cluster-job-report-running "Running Report")
- [Servers Cluster](#get-cluster-servers "Servers Cluster")
- [Servers Report](#post-cluster-job-report-servers "Servers Report")
- [States Report](#post-cluster-job-report-states "States Report")
- [Summary Jobs](#post-jobs-summary "Summary Jobs")
- [System Job](#get-cluster-job-system "System Job")

### <a id="get-cluster-job-batches"></a>Batches Job

GET /cluster/job/batches

#### Parameters

This function has no parameters.

### <a id="get-cluster-job-config"></a>Config Job

GET /cluster/job/config

#### Parameters

This function has no parameters.

### <a id="get-cluster-configuration"></a>Configuration Cluster

GET /cluster/configuration

#### Parameters

This function has no parameters.

### <a id="post-cluster-replicatedreadonly-invalidate"></a>Invalidate Replicatedreadonly

POST /cluster/replicatedreadonly/invalidate

#### Parameters

This function has no parameters.

### <a id="get-cluster-jobqueue"></a>Jobqueue Cluster

GET /cluster/jobqueue

#### Parameters

This function has no parameters.

### <a id="post-cluster-job-report-jobtree"></a>Jobtree Report

POST /cluster/job/report/jobtree

#### Parameters

This function has no parameters.

### <a id="post-cluster-job-instances-jobid-kill"></a>Kill Instance

POST /cluster/job/instances/{jobId}/kill

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| jobId | true | string |  |

### <a id="post-cluster-jobs-jobid-kill"></a>Kill Job

POST /cluster/jobs/{jobId}/kill

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| jobId | true | string |  |

### <a id="post-cluster-jobs-killall"></a>Killall Jobs

POST /cluster/jobs/killall

#### Parameters

This function has no parameters.

### <a id="get-cluster-jobs-jobid-dependencies"></a>List Dependencies

GET /cluster/jobs/{jobId}/dependencies

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| jobId | true | string |  |

### <a id="post-cluster-configuration-modify"></a>Modify Configuration

POST /cluster/configuration/modify

#### Parameters

This function has no parameters.

### <a id="post-cluster-job-instances-query"></a>Query

Queries for items of type cluster

POST /cluster/job/instances/query

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}
```

### <a id="post-cluster-job-batches-query"></a>Query

Queries for items of type cluster

POST /cluster/job/batches/query

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}
```

### <a id="post-cluster-job-queues-query"></a>Query

Queries for items of type cluster

POST /cluster/job/queues/query

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}
```

### <a id="post-cluster-jobs-query"></a>Query

Queries for matches

POST /cluster/jobs/query

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}
```

### <a id="get-cluster-job-queues"></a>Queues Job

GET /cluster/job/queues

#### Parameters

This function has no parameters.

### <a id="get-cluster-job-batches-batchid"></a>Read Batche

GET /cluster/job/batches/{batchId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| batchId | true | string |  |

### <a id="get-cluster"></a>Read Cluster

GET /cluster

#### Parameters

This function has no parameters.

### <a id="get-cluster-jobs-jobid-dependson"></a>Read Dependson Job

GET /cluster/jobs/{jobId}/dependson

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| jobId | true | string |  |

### <a id="get-cluster-job-instances-jobid"></a>Read Instance

GET /cluster/job/instances/{jobId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| jobId | true | string |  |

### <a id="get-cluster-jobs-jobid"></a>Read Job

GET /cluster/jobs/{jobId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| jobId | true | string |  |

### <a id="get-cluster-job-queues-queueid"></a>Read Queue

GET /cluster/job/queues/{queueId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| queueId | true | string |  |

### <a id="get-cluster-servers-serverid"></a>Read Server

GET /cluster/servers/{serverId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| serverId | true | string |  |

### <a id="get-cluster-servers-serverid-jobs-running"></a>Running Jobs

GET /cluster/servers/{serverId}/jobs/running

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| serverId | true | string |  |

### <a id="post-cluster-job-report-running"></a>Running Report

POST /cluster/job/report/running

#### Parameters

This function has no parameters.

### <a id="get-cluster-servers"></a>Servers Cluster

GET /cluster/servers

#### Parameters

This function has no parameters.

### <a id="post-cluster-job-report-servers"></a>Servers Report

POST /cluster/job/report/servers

#### Parameters

This function has no parameters.

### <a id="post-cluster-job-report-states"></a>States Report

POST /cluster/job/report/states

#### Parameters

This function has no parameters.

### <a id="post-jobs-summary"></a>Summary Jobs

POST /jobs/summary

#### Parameters

This function has no parameters.

### <a id="get-cluster-job-system"></a>System Job

GET /cluster/job/system

#### Parameters

This function has no parameters.

## <a id="schema"></a>Schema

```json

{
  "type": "object",
  "extends": "datastore",
  "description": "Cluster",
  "properties": {
    "defaultDomainId": {
      "type": "string"
    },
    "key": {
      "type": "string"
    },
    "title": null,
    "description": null,
    "datastoreId": null,
    "datastoreTypeId": null,
    "enableAuthorities": null,
    "size": null,
    "maxsize": null,
    "objectcount": null,
    "locked": null,
    "lockedBy": null,
    "statisticsDate": null,
    "statisticsDirty": null,
    "binaryStorageProviderType": null,
    "_doc": null,
    "_system": null
  },
  "id": "cluster"
}
```
