Overview
The Analytics Settings REST API is provided by the Analytics service. This API enables you to view or set cluster-level Analytics settings.
The API schemes and host URLs are as follows:
-
https://node:18091/ (for secure access)
where node
is the host name or IP address of a node running the Analytics service.
(Note that the port numbers for this REST API are different to the port numbers used by the other Analytics REST APIs.)
Paths
This section describes the operations available with this REST API.
View Analytics Settings
GET /settings/analytics
Description
Retrieves cluster-level Analytics settings. Note that only one setting is available: numReplicas
.
You can also retrieve the number of Analytic replicas using the Couchbase Web Console or the CLI. For further details about Analytics replicas, refer to Rebalance and Hard Failover.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The operation was successful. |
|
401 |
Unauthorized. The user name or password may be incorrect. |
object |
Modify Analytics Settings
POST /settings/analytics
Description
Sets cluster-level Analytics settings. Note that only one setting is available: numReplicas
.
You can also set the number of Analytic replicas using the Couchbase Web Console or the CLI. For further details about Analytics replicas, refer to Rebalance and Hard Failover.
A rebalance is required for a new numReplicas value to take effect.
|
Parameters
Type | Name | Description | Schema |
---|---|---|---|
FormData |
numReplicas |
Specifies the number of replicas for Analytics. |
integer |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
The operation was successful. |
|
400 |
Bad request. A parameter has an incorrect value. |
object |
401 |
Unauthorized. The user name or password may be incorrect. |
object |
Security
Cluster Read / Pools Read
The Analytics Settings REST API supports HTTP basic authentication. Credentials can be passed via HTTP headers.
Users must have one of the following RBAC roles:
-
Full Admin
-
Cluster Admin
-
Read-Only Admin
-
Analytics Admin
Refer to Roles for more details.
Type : basic