MarkLogic 12 Product Documentation

POST /manage/v2/groups

Summary

This resource address creates a new group in the cluster.

Response

Upon success, MarkLogic Server returns status code 201 (Created). If the group already exists or if the payload is malformed, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

http://marklogic.com/xdmp/privileges/manage-admin

Usage Notes

The structure of the data in the request is as shown below.

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, schemas, namespaces, using-namespaces, module-locations, events, audit-events, and audit-restrictions are expressed in singular form.

group-name

The name of a group of servers.

allow-dynamic-hosts

Specifies if we allow dynamic hosts joining this group.

cache-sizing

The cache sizing method.

list-cache-size

The size of the list cache, in megabytes.

list-cache-partitions

The number of list cache partitions.

compressed-tree-cache-size

The size of the compressed tree cache, in megabytes.

compressed-tree-cache-partitions

The number of compressed tree cache partitions.

expanded-tree-cache-size

The size of the expanded tree cache, in megabytes.

expanded-tree-cache-partitions

The number of expanded tree cache partitions.

triple-cache-size

The size of the triple cache, in megabytes.

triple-cache-partitions

The number of triple cache partitions.

triple-value-cache-size

The size of the triple value cache, in megabytes.

triple-value-cache-partitions

The number of triple value cache partitions.

compressed-tree-read-size

The block size for random-access compressed tree file reads, in kilobytes.

triple-cache-timeout

The number of seconds of inactivity before triple index pages are eligible to be flushed from the cache.

triple-value-cache-timeout

The number of seconds of inactivity before triple value index pages are eligible to be flushed from the cache.

smtp-relay

The network location of the SMTP mail relay host.

smtp-timeout

The SMTP response timeout, in seconds.

http-user-agent

The HTTP User-agent string used when making HTTP requests.

http-timeout

The HTTP response timeout, in seconds.

xdqp-timeout

The XDQP protocol timeout, in seconds.

host-timeout

The host response timeout, in seconds.

host-initial-timeout

The host initial response timeout, in seconds.

retry-timeout

The request retry timeout, in seconds.

module-cache-timeout

Flush from caches modules unused after this many seconds.

system-log-level

The minimum log level for log messages sent to the operating system.

file-log-level

The minimum log level for log messages in the log file.

rotate-log-files

When to start a new log file.

keep-log-files

How many log files to keep.

failover-enable

Enable forest assignment to a failover host when the primary host is down.

xdqp-ssl-enabled

Whether or not SSL is enabled for XDQP.

xdqp-ssl-min-allow-tls

minimum TLS protocol allow in XDQP

xdqp-ssl-ciphers

For TLS 1.2, a colon separated list of ciphers (e.g. ALL:!LOW:@STRENGTH) in XDQP. This does not affect TLS 1.3.

xdqp-ssl-ciphersuites

For TLS 1.3, a colon separated list of ciphersuites in XDQP. This does not affect TLS 1.2.

schemas

The schema binding specifications.

This is a complex structure with the following children:

schema

A schema binding specification.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

schema-location

A schema location.

namespaces

The namespace binding specifications.

This is a complex structure with the following children:

namespace

A namespace binding specification.

This is a complex structure with the following children:

prefix

A QName prefix.

namespace-uri

A namespace URI.

using-namespaces

The default namespace bindings.

This is a complex structure with the following children:

using-namespace

A namespace path URI.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

module-locations

The module location specifications.

This is a complex structure with the following children:

module-location

A module location specification.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

location

A module location.

events-activated

Activates the trace event mechanism.

events

The list of events to enable.

This is a complex structure with the following children:

event

The event specification.

audit

Audit specification.

This is a complex structure with the following children:

audit-enabled

Enables auditing.

rotate-audit-files

When to start a new audit log file.

keep-audit-files

How many audit files to keep.

audit-events

The list of audit events to enable.

This is a complex structure with the following children:

audit-event

The audit event specification.

This is a complex structure with the following children:

audit-event-name

The string identifier of the audit event.

audit-event-enabled

Enables a specified audit event.

audit-restrictions

The list of audit restrictions.

This is a complex structure with the following children:

audit-restriction

The audit restriction specification.

This is a complex structure with the following children:

audit-restriction-name

The string identifier of the audit restriction.

audit-restriction-type

The string identifier of the audit restriction.

audit-restriction-items

The string identifier of the audit restriction.

background-io-limit

The maximum I/O rate allowable for background operations (merge, backup, restore).

metering-enabled

Enable Usage metering.

performance-metering-enabled

Enable performance monitoring history.

meters-database

The metering and performance history database.

performance-metering-period

Historic performance metering period (seconds).

performance-metering-retain-raw

Retain raw performance metering data in days.

performance-metering-retain-hourly

Retain hourly performance metering data in days.

performance-metering-retain-daily

Retain daily performance metering data in days.

telemetry-log-level

The minimum log level for log messages collected by telemetry. A value of 'disabled' disables all telemetry use of log data.

telemetry-metering

The type of metering data collected by telemetry.

telemetry-config

The type of configuration data collected by telemetry.

telemetry-usage

Whether or not the usage data is collected by telemetry.

telemetry-session-endpoint

The REST URI for the Telemetry Session API endpoint.

telemetry-proxy

The URL of the local telemetry proxy.

s3-domain

The simple storage service internet domain name.

s3-protocol

The simple storage service network protocol.

s3-server-side-encryption

Specifies server side encryption for data at rest on the simple storage service.

s3-server-side-encryption-kms-key

Specifies the AWS KMS key ID for server side encryption.

s3-proxy

The URL of the proxy server to access S3.

azure-storage-proxy

The URL of the proxy server to access Azure Blob Storage.

security-database

The security database where global security data are kept for hosts in this group.

temporary-directory

The directory used for external disk based sorting/joining, converters and plugins

optimized-plan-cache-timeout

The optimized plan cache timeout in seconds. If not specified 256 is used.

Example

curl -X POST --digest -u admin:admin -H "Content-type: application/json" \
-d '{"group-name":"Foo"}' http://localhost:8002/manage/v2/groups

==>  Creates a new group, named "Foo," in the cluster.