Overview
The Analytics Configuration REST API is provided by the Analytics service. This API enables you to configure Analytics nodes and clusters.
Version information
Version : 7.6
Host information
{scheme}://{host}:{port}
The URL scheme, host, and port are as follows.
Component | Description |
---|---|
scheme |
The URL scheme. Use Values: |
host |
The host name or IP address of a node running the Analytics service. Example: |
port |
The Analytics service REST port. Use Values: |
Resources
This section describes the operations available with this REST API.
View Node-Specific Parameters
View Service-Level Parameters
Modify Node-Specific Parameters
Modify Service-Level Parameters
View Node-Specific Parameters
GET /analytics/config/node
Description
Views node-specific parameters, which apply to the node receiving the request.
-
application/json
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success. Returns an object listing the configurable node-level parameters and their current values. |
|
401 |
Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to Error Codes. |
Object |
View Service-Level Parameters
GET /analytics/config/service
Description
Views service-level parameters, which apply to all nodes running the Analytics service.
-
application/json
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success. Returns an object listing the configurable service-level parameters and their current values. |
|
401 |
Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to Error Codes. |
Object |
Example HTTP Request
curl -v -u Administrator:password \
http://localhost:8095/analytics/config/service
Example HTTP Response
{
"activeMemoryGlobalBudget" : 67108864,
"activeStopTimeout" : 3600,
"activeSuspendTimeout" : 3600,
"analyticsBroadcastDcpStateMutationCount" : 10000,
"analyticsHttpRequestQueueSize" : 256,
"analyticsHttpThreadCount" : 16,
"bindAddress" : null,
"bindToHost" : false,
"clusterConnectRetries" : 5,
"collectDcpStateFromNodesTimeout" : 600,
"compilerFramesize" : 32768,
"compilerGroupmemory" : 33554432,
"compilerJoinmemory" : 33554432,
"compilerParallelism" : 0,
"compilerSortParallel" : false,
"compilerSortmemory" : 33554432,
"compilerWindowmemory" : 33554432,
"coresMultiplier" : 3,
"dcpBufferAckWatermark" : 20,
"dcpChannelReconnectRemoteIdleSeconds" : 120,
"dcpConnectionBufferSize" : 10485760,
"deadlockWatchdogHaltDelaySeconds" : 120,
"deadlockWatchdogPollSeconds" : 300,
"jobHistorySize" : 10,
"jobQueueCapacity" : 4096,
"jvmArgs" : null,
"logLevel" : "DEBUG",
"maxWebRequestSize" : 209715200,
"netBufferCount" : 1,
"netThreadCount" : 1,
"rebalancePullDatasetSizeFrequency" : 5,
"remoteLinkConnectTimeoutSeconds" : 60,
"remoteLinkSocketTimeoutSeconds" : 60,
"requestsArchiveSize" : 50,
"resultSweepThreshold" : 60000,
"resultTtl" : 86400000,
"storageBuffercacheMaxopenfiles" : 2147483647,
"storageBuffercachePagesize" : 131072,
"storageCompressionBlock" : "snappy",
"storageMemorycomponentNumcomponents" : 2,
"storageMemorycomponentPagesize" : 131072,
"storageWriteRateLimit" : 0,
"threaddumpFrequencySeconds" : 300,
"threaddumpLogLevel" : "DEBUG",
"traceCategories" : [ ],
"txnDatasetCheckpointInterval" : 3600
}
Modify Node-Specific Parameters
PUT /analytics/config/node
Description
Views node-specific parameters, which apply to the node receiving the request.
IMPORTANT: For the configuration changes to take effect, you must restart the node using the Node Restart API, or restart the Analytics cluster using the Cluster Restart API.
-
application/json
-
application/x-www-form-urlencoded
-
application/json
Parameters
By default, the API accepts parameters using the application/x-www-form-urlencoded
MIME type.
You can specify the application/json
MIME type using the Content-Type
header of the PUT request.
Name | Description | Schema |
---|---|---|
Body |
An object specifying one or more of the configurable node-level parameters on this node. |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The operation was successful. |
|
400 |
Bad request. Unknown parameter or incorrect value. |
|
401 |
Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to Error Codes. |
Object |
Modify Service-Level Parameters
PUT /analytics/config/service
Description
Modifies service-level parameters, which apply to all nodes running the Analytics service.
IMPORTANT: For the configuration changes to take effect, you must restart the Analytics cluster using the Cluster Restart API.
-
application/json
-
application/x-www-form-urlencoded
-
application/json
Parameters
By default, the API accepts parameters using the application/x-www-form-urlencoded
MIME type.
You can specify the application/json
MIME type using the Content-Type
header of the PUT request.
Name | Description | Schema |
---|---|---|
Body |
An object specifying one or more of the configurable service-level parameters. |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The operation was successful. |
|
400 |
Bad request. Unknown parameter or incorrect value. |
|
401 |
Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to Error Codes. |
Object |
Definitions
This section describes the properties consumed and returned by this REST API.
Node
Property | Schema | |
---|---|---|
jvmArgs |
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 |
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 |
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 |
Service
Property | Schema | |
---|---|---|
activeMemoryGlobalBudget |
The memory budget (in bytes) for the active runtime. Default: |
Integer (int32) |
activeStopTimeout |
The maximum time (in seconds) to wait for a graceful stop of an active runtime. Default: |
Integer (int32) |
activeSuspendTimeout |
The maximum time (in seconds) to wait for a graceful suspend of an active runtime. Default: |
Integer (int32) |
analyticsBroadcastDcpStateMutationCount |
The number of processed mutations after which the DCP state is broadcast to storage Default: |
Integer (int32) |
analyticsHttpRequestQueueSize |
The maximum number of HTTP requests to queue pending ability to execute. Default: |
Integer (int32) |
analyticsHttpThreadCount |
The number of threads to service HTTP requests. Default: |
Integer (int32) |
bindAddress |
The bind address to use. |
String |
bindToHost |
Bind to configured hostname instead of wildcard address. Default: |
Boolean |
clusterConnectRetries |
Number of attempts to contact CC before giving up. Default: |
Integer (int32) |
collectDcpStateFromNodesTimeout |
The maximum time to wait to collect DCP state from all nodes in seconds. Default: |
Integer (int32) |
compilerFramesize |
The page size (in bytes) for computation. Default: |
Integer (int32) |
compilerGroupmemory |
The memory budget (in bytes) for a group by operator instance in a partition. Default: |
Integer (int32) |
compilerJoinmemory |
The memory budget (in bytes) for a join operator instance in a partition. Default: |
Integer (int32) |
compilerParallelism |
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: |
Integer (int32) |
compilerSortParallel |
Enables or disables full parallel sort. Default: |
Boolean |
compilerSortmemory |
The memory budget (in bytes) for a sort operator instance in a partition. Default: |
Integer (int32) |
compilerWindowmemory |
The memory budget (in bytes) for a window operator instance in a partition. Default: |
Integer (int32) |
coresMultiplier |
The factor to multiply by the number of cores to determine maximum query concurrent execution level. Default: |
Integer (int32) |
dcpBufferAckWatermark |
The percentage of DCP connection buffer size at which to acknowledge bytes consumed to DCP producer. Default: |
Integer (int32) |
dcpChannelReconnectRemoteIdleSeconds |
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: |
Integer (int32) |
dcpConnectionBufferSize |
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 |
The delay (in seconds) to wait for graceful shutdown due to deadlocked threads, before halting. Default: |
Integer (int32) |
deadlockWatchdogPollSeconds |
The frequency (in seconds) to scan for deadlocked threads. Default: |
Integer (int32) |
jobHistorySize |
Limits the number of historical jobs remembered by the system to the specified value. Default: |
Integer (int32) |
jobQueueCapacity |
The maximum number of jobs to queue before rejecting new jobs. Default: |
Integer (int32) |
jvmArgs |
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 |
The logging level. Default: |
String |
maxWebRequestSize |
The maximum accepted web request size in bytes. Default: |
Integer (int32) |
netBufferCount |
Number of network buffers per input/output channel. Default: |
Integer (int32) |
netThreadCount |
Number of threads to use for Network I/O. Default: |
Integer (int32) |
rebalancePullDatasetSizeFrequency |
The frequency at which the Analytics collection size is pulled from nodes during rebalance in seconds. Default: |
Integer (int32) |
remoteLinkConnectTimeoutSeconds |
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: |
Integer (int32) |
remoteLinkSocketTimeoutSeconds |
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: |
Integer (int32) |
requestsArchiveSize |
The maximum number of archived requests to maintain. Default: |
Integer (int32) |
resultSweepThreshold |
The duration within which an instance of the result cleanup should be invoked in milliseconds. Default: |
Integer (int32) |
resultTtl |
Limits the amount of time results for asynchronous jobs should be retained by the system in milliseconds. Default: |
Integer (int32) |
storageBuffercacheMaxopenfiles |
The maximum number of open files in the buffer cache. Default: |
Integer (int32) |
storageBuffercachePagesize |
The page size in bytes for pages in the buffer cache. Default: |
Integer (int32) |
storageCompressionBlock |
The default compression scheme for the storage. Default: |
String |
storageMemorycomponentNumcomponents |
The number of memory components to be used per LSM index. Default: |
Integer (int32) |
storageMemorycomponentPagesize |
The page size in bytes for pages allocated to memory components. Default: |
Integer (int32) |
storageWriteRateLimit |
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: |
Long (int64) |
threaddumpFrequencySeconds |
The frequency (in seconds) at which to log diagnostic thread dumps. Default: |
Integer (int32) |
threaddumpLogLevel |
The log level at which to emit diagnostic thread dumps. Default: |
String |
traceCategories |
Categories for tracing. The default is the empty array — no categories. Default: |
String array |
txnDatasetCheckpointInterval |
The interval (in seconds) after which an Analytics collection is considered idle and persisted to disk. Default: |
Integer (int32) |
Security
The Analytics Configuration REST API supports HTTP basic authentication. Credentials can be passed via HTTP headers.
Analytics Manage
Users must have one of the following RBAC roles:
- Full Admin
- Cluster Admin
- Analytics Admin
Type : http
Refer to Roles for more details.