Analytics Configuration REST API

activeMemoryGlobalBudget
optional

The memory budget (in bytes) for the active runtime.
Default : 67108864

integer (int32)

activeStopTimeout
optional

The maximum time (in seconds) to wait for a graceful stop of an active runtime.
Default : 3600

integer (int32)

activeSuspendTimeout
optional

The maximum time (in seconds) to wait for a graceful suspend of an active runtime.
Default : 3600

integer (int32)

analyticsBroadcastDcpStateMutationCount
optional

The number of processed mutations after which the DCP state is broadcast to storage
Default : 10000

integer (int32)

analyticsHttpRequestQueueSize
optional

The maximum number of HTTP requests to queue pending ability to execute.
Default : 256

integer (int32)

analyticsHttpThreadCount
optional

The number of threads to service HTTP requests.
Default : 16

integer (int32)

bindAddress
optional

The bind address to use.

string

bindToHost
optional

Bind to configured hostname instead of wildcard address.
Default : false

boolean

clusterConnectRetries
optional

Number of attempts to contact CC before giving up.
Default : 5

integer (int32)

collectDcpStateFromNodesTimeout
optional

The maximum time to wait to collect DCP state from all nodes in seconds.
Default : 600

integer (int32)

compilerFramesize
optional

The page size (in bytes) for computation.
Default : 32768

integer (int32)

compilerGroupmemory
optional

The memory budget (in bytes) for a group by operator instance in a partition.
Default : 33554432

integer (int32)

compilerJoinmemory
optional

The memory budget (in bytes) for a join operator instance in a partition.
Default : 33554432

integer (int32)

compilerParallelism
optional

The degree of parallelism for query execution. Zero means to use the storage parallelism as the query execution parallelism, while other integer values dictate the number of query execution parallel partitions. The system will fall back to use the number of all available CPU cores in the cluster as the degree of parallelism if the number set by a user is too large or too small.
Default : 0

integer (int32)

compilerSortParallel
optional

Enables or disables full parallel sort.
Default : false

boolean

compilerSortmemory
optional

The memory budget (in bytes) for a sort operator instance in a partition.
Default : 33554432

integer (int32)

compilerWindowmemory
optional

The memory budget (in bytes) for a window operator instance in a partition.
Default : 33554432

integer (int32)

coresMultiplier
optional

The factor to multiply by the number of cores to determine maximum query concurrent execution level.
Default : 3

integer (int32)

dcpBufferAckWatermark
optional

The percentage of DCP connection buffer size at which to acknowledge bytes consumed to DCP producer.
Default : 20
Minimum value : 1
Maximum value : 100

integer (int32)

dcpChannelReconnectRemoteIdleSeconds
optional

Reconnect remote DCP channels that are idle for the specified number of seconds to ensure permissions have not been lost. A value of 0 disables reconnects on idle.
Default : 120

integer (int32)

dcpConnectionBufferSize
optional

DCP connection buffer size (in bytes).

If the JVM maximum heap size is less than 8GB, the default for this parameter is 10 MB divided by the number of IO Devices on the node. Otherwise, the default is 1% of the JVM maximum heap size divided by the number of IO Devices on the node.

integer (int32)

deadlockWatchdogHaltDelaySeconds
optional

The delay (in seconds) to wait for graceful shutdown due to deadlocked threads, before halting.
Default : 120

integer (int32)

deadlockWatchdogPollSeconds
optional

The frequency (in seconds) to scan for deadlocked threads.
Default : 300

integer (int32)

jobHistorySize
optional

Limits the number of historical jobs remembered by the system to the specified value.
Default : 10

integer (int32)

jobQueueCapacity
optional

The maximum number of jobs to queue before rejecting new jobs.
Default : 4096

integer (int32)

jvmArgs
optional

JVM arguments to pass to the Analytics Driver. The default is undefined (null).

Note that JVM arguments are generally not secure, and are exposed by cbcollect_info and the System Event log. To pass arguments opaquely, you may use Java command-line argument files.

string

logLevel
optional

The logging level.
Default : "DEBUG"

string

maxWebRequestSize
optional

The maximum accepted web request size in bytes.
Default : 52428800

integer (int32)

netBufferCount
optional

Number of network buffers per input/output channel.
Default : 1

integer (int32)

netThreadCount
optional

Number of threads to use for Network I/O.
Default : 1

integer (int32)

rebalancePullDatasetSizeFrequency
optional

The frequency at which the Analytics collection size is pulled from nodes during rebalance in seconds.
Default : 5

integer (int32)

remoteLinkConnectTimeoutSeconds
optional

The maximum time (in seconds) to wait for a remote link connection to establish. A value of 0 disables timeout; a value of -1 sets timeout to the system default.
Default : 60

integer (int32)

remoteLinkSocketTimeoutSeconds
optional

The maximum time (in seconds) to wait after establishing the connection for remote links; the maximum time of inactivity between two data packets. A value of 0 disables timeout; a value of -1 sets timeout to the system default.
Default : 60

integer (int32)

requestsArchiveSize
optional

The maximum number of archived requests to maintain.
Default : 50

integer (int32)

resultSweepThreshold
optional

The duration within which an instance of the result cleanup should be invoked in milliseconds.
Default : 60000

integer (int32)

resultTtl
optional

Limits the amount of time results for asynchronous jobs should be retained by the system in milliseconds.
Default : 86400000

integer (int32)

storageBuffercacheMaxopenfiles
optional

The maximum number of open files in the buffer cache.
Default : 2147483647

integer (int32)

storageBuffercachePagesize
optional

The page size in bytes for pages in the buffer cache.
Default : 131072

integer (int32)

storageCompressionBlock
optional

The default compression scheme for the storage.
Default : "snappy"

string

storageMemorycomponentNumcomponents
optional

The number of memory components to be used per LSM index.
Default : 2

integer (int32)

storageMemorycomponentPagesize
optional

The page size in bytes for pages allocated to memory components.
Default : 131072

integer (int32)

storageWriteRateLimit
optional

The maximum disk write rate for each storage partition in bytes per second. Disabled if the provided value is less than or equal to 0.
Default : 0

integer (int64)

threaddumpFrequencySeconds
optional

The frequency (in seconds) at which to log diagnostic thread dumps.
Default : 300

integer (int32)

threaddumpLogLevel
optional

The log level at which to emit diagnostic thread dumps.
Default : "DEBUG"

string

traceCategories
optional

Categories for tracing. The default is the empty array — no categories.

< object > array

txnDatasetCheckpointInterval
optional

The interval (in seconds) after which an Analytics collection is considered idle and persisted to disk.
Default : 3600

integer (int32)

jvmArgs
optional

JVM arguments to pass to the Analytics Driver. The default is undefined (null).

Node-specific JVM arguments are appended to service-level JVM arguments. If the same JVM argument appears in both the service-level arguments and the node-specific arguments, the node-specific argument takes priority.

Note that JVM arguments are generally not secure, and are exposed by cbcollect_info and the System Event log. To pass arguments opaquely, you may use Java command-line argument files.

string

storageBuffercacheSize
optional

The size of memory allocated to the disk buffer cache. The value should be a multiple of the buffer cache page size.

The default is 1/4 of the allocated Analytics Service memory.

integer

storageMemorycomponentGlobalbudget
optional

The size of memory allocated to the memory components. The value should be a multiple of the memory component page size.

The default is 1/4 of the allocated Analytics Service memory.

integer

error
required

An error message.

string