Configuring Memory
- reference
Use REST API to configure custom memory allocation per service.
Description
Allows a custom memory quota to be established for the Multi-Dimensional Scaling (MDS) services Data, Index, Search, Eventing, and Analytics. The Query and Backup Services do not require a memory allocation. If no custom quota was specified during configuration for 1 or more services, those services retain the default allocations. These are the default allocations:
-
256 Mb for kv (Data Service)
-
256 Mb for fts (Search Service)
-
512 Mb for index (Index Service)
-
256 Mb for eventing (Eventing Service)
-
1024 Mb for cbas (Analytics Service)
For more information about the maximum memory allocation permitted for a node, see Service Memory Quotas.
Curl Syntax
curl -v -X POST http://10.144.220.101:8091/pools/default \ -d memoryQuota=<integer> \ -d indexMemoryQuota=<integer> \ -d eventingMemoryQuota=<integer> \ -d ftsMemoryQuota=<integer> \ -d cbasMemoryQuota=<integer> \ -u <username>:<password>
During the process of provisioning a single-node cluster, username
and password
are required after the administrator has established credentials, as explained in Establishing Credentials.
Responses
Value | Description |
---|---|
|
Successful call. |
|
Invalid parameter. |
|
Authorization failure due to incorrect username or password. |
|
The provided username has insufficient privileges to call this method. |
|
Error in the URI path. |
|
Error in Couchbase Server. |
Example
The following example establishes the minimum allowed value for each service:
curl -v -X POST http://10.144.220.101:8091/pools/default \ -u Administrator:password -d 'memoryQuota=256' \ -d 'indexMemoryQuota=256' \ -d 'eventingMemoryQuota=256' \ -d 'ftsMemoryQuota=256' \ -d 'cbasMemoryQuota=1024'
See Also
-
For more information about the maximum memory allocation permitted for a node, see Service Memory Quotas.
-
For more information about the other aspects of provisioning a single-node cluster, see Initializing a Node, Naming a Node, Naming a Cluster, Assigning Services to a New Single Node, and Establishing Credentials.
-
For more information on initialization and provisioning — using the UI, the CLI, and the REST API — see Manage Nodes and Clusters.
-
For more information about retrieving memory information for services using the REST API, see Getting Memory Information.