Cluster

A Data Store

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Objects

This Cluster contains the following objects:

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

Methods

The following methods are available:

Batches

GET /cluster/job/batches

Parameters

This function has no parameters.

Response

{}

Cluster

GET /cluster

Parameters

This function has no parameters.

Response

{}

Config

GET /cluster/job/config

Parameters

This function has no parameters.

Response

{}

Configuration

GET /cluster/configuration

Parameters

This function has no parameters.

Response

{}

Dependencies

GET /cluster/jobs/{jobId}/dependencies

Parameters

Name Required Type Description
jobId true string

Response

{}

Dependson

GET /cluster/jobs/{jobId}/dependson

Parameters

Name Required Type Description
jobId true string

Response

{}

Invalidate

POST /cluster/replicatedreadonly/invalidate

Parameters

This function has no parameters.

Response

{}

Jobqueue

GET /cluster/jobqueue

Parameters

This function has no parameters.

Response

{}

Jobtree

POST /cluster/job/report/jobtree

Parameters

This function has no parameters.

Response

{}

Kill

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

Parameters

Name Required Type Description
jobId true string

Response

{}

Kill

POST /cluster/jobs/{jobId}/kill

Parameters

Name Required Type Description
jobId true string

Response

{}

Killall

POST /cluster/jobs/killall

Parameters

This function has no parameters.

Response

{}

Modify

POST /cluster/configuration/modify

Parameters

This function has no parameters.

Response

{}

Query

Queries for items of type cluster
POST /cluster/job/instances/query

Parameters

This function has no parameters.

Response

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

Query

Queries for items of type cluster
POST /cluster/job/batches/query

Parameters

This function has no parameters.

Response

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

Query

Queries for items of type cluster
POST /cluster/job/queues/query

Parameters

This function has no parameters.

Response

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

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

Response

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

Queues

GET /cluster/job/queues

Parameters

This function has no parameters.

Response

{}

Running

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

Parameters

Name Required Type Description
serverId true string

Response

{}

Running

POST /cluster/job/report/running

Parameters

This function has no parameters.

Response

{}

Servers

POST /cluster/job/report/servers

Parameters

This function has no parameters.

Response

{}

Servers

GET /cluster/servers

Parameters

This function has no parameters.

Response

{}

States

POST /cluster/job/report/states

Parameters

This function has no parameters.

Response

{}

Summary

POST /jobs/summary

Parameters

This function has no parameters.

Response

{}

System

GET /cluster/job/system

Parameters

This function has no parameters.

Response

{}

{batchId}

GET /cluster/job/batches/{batchId}

Parameters

Name Required Type Description
batchId true string

Response

{}

{jobId}

GET /cluster/job/instances/{jobId}

Parameters

Name Required Type Description
jobId true string

Response

{}

{jobId}

GET /cluster/jobs/{jobId}

Parameters

Name Required Type Description
jobId true string

Response

{}

{queueId}

GET /cluster/job/queues/{queueId}

Parameters

Name Required Type Description
queueId true string

Response

{}

{serverId}

GET /cluster/servers/{serverId}

Parameters

Name Required Type Description
serverId true string

Response

{}

Schema


{
  "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"
}