Skip to content

index.adoc

Latest commit

 

History

History
2978 lines (2008 loc) · 56.3 KB

index.adoc

File metadata and controls

2978 lines (2008 loc) · 56.3 KB

Analytics Administration REST APIs

Overview

The Analytics Administration REST APIs are provided by the Analytics service. These APIs enables you to manage and monitor the Analytics service.

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 https for secure access.

Values: http, https

host

The host name or IP address of a node running the Analytics Service.

Example: localhost

port

The Analytics Service REST port. Use 18095 for secure access.

Values: 8095, 18095

Resources

This section describes the operations available with this REST API.

Request Cancellation

DELETE /analytics/admin/active_requests

Parameters

Form Parameters

Name Description Schema

client_context_id
required

Identifier passed by the client that is used to identify an active request to be cancelled.

String

Responses

HTTP Code Description Schema

200

The operation was successful.

400

Bad request. Incorrect parameter or missing value.

401

Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to [Error Codes](/server/7.6/analytics/error-codes.html).

Object

404

Not found. The path may be incorrect, or there is no active request with the specified identifier.

Cluster Status

GET /analytics/cluster

Responses

HTTP Code Description Schema

200

Success. Returns an object giving the current status of the Analytics Service.

401

Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to [Error Codes](/server/7.6/analytics/error-codes.html).

Object

404

Not found. The path may be incorrect.

Completed Requests

GET /analytics/admin/completed_requests

Responses

HTTP Code Description Schema

200

Success. Returns a list of all completed analytic requests.

Request array

401

Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to [Error Codes](/server/7.6/analytics/error-codes.html).

Object

404

Not found. The path may be incorrect.

Ingestion Status

GET /analytics/status/ingestion

Responses

HTTP Code Description Schema

200

Success. Returns an object giving the ingestion status of each Analytics collection.

401

Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to [Error Codes](/server/7.6/analytics/error-codes.html).

Object

404

Not found. The path may be incorrect.

Pending Mutations

GET /analytics/node/agg/stats/remaining
Caution
 This operation is deprecated, and will be removed in a future release.

Description

Shows the number of mutations in the DCP queue that have not yet been ingested by the Analytics service, for each Analytics collection.

Note
 This endpoint may not return meaningful results in Couchbase Server 7.0 and later. The reported number of mutations may be different to the actual number of mutations in the Analytics collection. For this reason, this endpoint has been deprecated, and you should use the [Ingestion Status](#ingestion_status) endpoint instead.
Produces

  • application/json

Responses

HTTP Code Description Schema

200

Success. Returns an object giving the number of pending mutations for each Analytics collection.

401

Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to [Error Codes](/server/7.6/analytics/error-codes.html).

Object

404

Not found. The path may be incorrect.

Cluster Restart

POST /analytics/cluster/restart

Responses

HTTP Code Description Schema

202

Accepted. Returns an object showing the status of the cluster.

Object

401

Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to [Error Codes](/server/7.6/analytics/error-codes.html).

Object

404

Not found. The path may be incorrect.

Node Restart

POST /analytics/node/restart

Responses

HTTP Code Description Schema

202

Accepted. Returns an object showing the status of the node.

Object

401

Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to [Error Codes](/server/7.6/analytics/error-codes.html).

Object

404

Not found. The path may be incorrect.

Active Requests

GET /analytics/admin/active_requests

Responses

HTTP Code Description Schema

200

Success. Returns an array id details on the running requests.

Request array

401

Unauthorized. The user name or password may be incorrect. Returns an object containing an error message. Refer to [Error Codes](/server/7.6/analytics/error-codes.html).

Object

404

Not found. The path may be incorrect.

Definitions

This section describes the properties consumed and returned by this REST API.

Ingestion

[brackets curly] Object

Property Schema

links
optional

An array of objects, each giving information about a single linked Analytics scope.

Links array

Links

[brackets curly] Object

Property Schema

name
optional

The name of the link.

Example: "Local"

String

scope
optional

The name of the Analytics scope.

Example: "travel-sample/inventory"

String

status
optional

The status of the Analytics scope.

Values: "healthy", "stopped", "unhealthy", "suspended"
Example: "healthy"

String

state
optional

An array of objects, each giving the ingestion state of one or more Analytics collections.

Analytics collections which have the same ingestion state within this Analytics scope are aggregated together.

States array

States

[brackets curly] Object

Property Schema

timestamp
required

The time since epoch that this sample was calculated, in milliseconds.

Example: 1631273689161

Integer

progress
required

The percentage (fraction from 0 to 1) of ingestion progress at the current time.

Minimum: 0
Maximum: 1
Example: 0

Double (double)

timeLag
optional

The estimated time that the ingestion lags behind the Data service, in milliseconds. Only displayed for Analytics collections that are not fully ingested.

Example: 9744

Integer

itemsProcessed
optional

The number of items ingested since last connect; that is, the total number of mutations and deletions processed. Only displayed for Analytics collections that are not fully ingested.

Note that this value is reset on connect, so it may appear to get smaller.

Example: 12301

Integer

seqnoAdvances
optional

The change in sequence number (seqno) since last connect. Only displayed for Analytics collections that are not fully ingested.

Example: 61

Integer

scopes
required

An array of objects, each one giving information about a single Analytics scope.

State Scopes array

State Scopes

[brackets curly] Object

Property Schema

name
required

The name of the Analytics scope.

Example: "travel-sample/inventory"

String

collections
required

An array of objects, each one giving information about a single Analytics collection.

State Collections

[brackets curly] Object

Property Schema

name
required

The name of the Analytics collection.

Example: "route"

String

Mutations

[brackets curly] Object

Property Schema

additional
property

Collections

[brackets curly] Object

Property Schema

additional
property

The number of mutations in the DCP queue that have not yet been ingested. The name of the property is the name of the Analytics collection.

Integer

Request

[brackets curly] Object

Property Schema

cancellable
optional

Whether this request can be cancelled.

Boolean

clientContextID
optional

A context ID for debugging purposes.

Example: "28379d60-7139-44d6-b57a-95935540b586"

String

elapsedTime
optional

How long the request has been running in seconds.

Example: 0.126

BigDecimal

jobCreateTime
optional

The date and time when the request’s job was created.

Example: "2024-05-28T19:47:02.512"

String

jobId
optional

The request’s job ID. This value can be null if request did not run (for example, due to an error).

Example: "JID:0.14"

String

jobQueueTime
optional

How long the request’s job has been in the queue waiting to run in seconds.

Example: 0

BigDecimal

jobRequiredCPUs
optional

The number of CPU cores required to run this request.

Example: 1

Integer

jobRequiredMemory
optional

The bytes of RAM being used to process this request.

Example: 34013184

Integer

jobStartTime
optional

The date and time the request’s job began running.

Example: "2024-05-28T19:47:02.514"

String

jobStatus
optional

The state of the request’s job.

Values: "PENDING", "RUNNING", "TERMINATED", "FAILURE", "FAILURE_BEFORE_EXECUTION", "null"
Example: "RUNNING"

String

plan
optional

The query plan for this request.

String

node
optional

The Analytics node that received the request.

Example: "172.20.0.2:8095"

String

remoteAddr
optional

The network address and port of the client that made the request.

Example: "172.20.0.123:53612"

String

requestTime
optional

The date and time the request was received.

Example: "2024-05-28T19:44:07.730"

String

scanConsistency
optional

The Scan Consistency setting used for the request’s query.

Example: "not_bounded"

String

state
optional

The state of the request.

Values: "received", "running", "cancelled", "completed"
Example: "running"

String

statement
optional

The SQL++ query statement being run by the request.

Example: "select count(*) from hotel_endorsement_view;"

String

userAgent
optional

The user agent string of the browser that made the request.

Example: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:126.0) Gecko/20100101 Firefox/126.0"

String

users
optional

The user who made the request.

Example: "Administrator"

String

uuid
optional

The unique identifier for this request.

Example: "91f60338-a3e0-4163-9287-5e723fda29ef"

String

Status

[brackets curly] Object

Property Schema

authorizedNodes
optional

An array of strings, each of which is the ID of an authorized Analytics node.

Example: ["86586a966202b5aa4aed31633f330aba","948fb3af810a9b7bc6c76e2a69ba35d9"]

String array

ccNodeId
optional

The ID of the cluster controller node.

Example: "86586a966202b5aa4aed31633f330aba"

String

nodeConfigUri
optional

The path of the Analytics Node Configuration REST API.

Example: "/analytics/config/node"

String

nodeDiagnosticsUri
optional

The path of the Analytics Node Diagnostics REST API. For internal use only.

Example: "/analytics/node/diagnostics"

String

nodeRestartUri
optional

The path of the Analytics Node Restart REST API.

Example: "/analytics/node/restart"

String

nodeServiceUri
optional

The path of the Analytics Query Service REST API.

Example: "/analytics/service"

String

serviceConfigUri
optional

The path of the Analytics Service Configuration REST API.

Example: "/analytics/config/service"

String

serviceDiagnosticsUri
optional

The full URI of the Analytics Service Diagnostics REST API. For internal use only.

Example: "http://localhost:8095/analytics/cluster/diagnostics"

String

serviceRestartUri
optional

The full URI of the Analytics Cluster Restart REST API.

Example: "http://localhost:8095/analytics/cluster/restart"

String

state
optional

The state of the Analytics Service.

Values: "ACTIVE", "REBALANCE_REQUIRED", "UNUSABLE", "SHUTTING_DOWN"
Example: "ACTIVE"

String

nodes
optional

An array of objects, each giving information about one Analytics node.

Nodes array

partitions
optional

An array of objects, each giving information about one Analytics partition.

Partitions array

partitionsTopology
optional

Nodes

[brackets curly] Object

Property Schema

apiBase
optional

The URI scheme, host, and port for HTTP access to Analytics REST APIs on this node.

Example: "http://192.168.8.101:8095"

String

apiBaseHttps
optional

The URI scheme, host, and port for secure HTTPS access to Analytics REST APIs on this node.

Example: "https://192.168.8.101:18095"

String

nodeId
optional

The ID of the node.

Example: "86586a966202b5aa4aed31633f330aba"

String

nodeName
optional

The name or IP address of the node, including the cluster administration port.

Example: "192.168.8.101:8091"

String

Partitions

[brackets curly] Object

Property Schema

active
optional

Indicates whether this partition is active.

Example: true

Boolean

activeNodeId
optional

The ID of the node where this partition is currently active.

Example: "86586a966202b5aa4aed31633f330aba"

String

iodeviceNum
optional

The number of the IO Device where this partition is located.

Example: 0

Integer

nodeId
optional

The ID of the node where this partition originated.

Example: "86586a966202b5aa4aed31633f330aba"

String

partitionId
optional

The ID of this partition.

Example: 0

Integer

path
optional

The path of the IO Device where this partition is located.

Example: "/data/@analytics/v_iodevice_0"

String

pendingActivation
optional

Indicates whether this partition is waiting to become active.

Example: false

Boolean

Partition Topology

[brackets curly] Object

Property Schema

balanced
optional

Indicates whether the Analytics nodes are balanced.

Example: true

Boolean

ccNodeId
optional

The ID of the cluster controller node.

Example: "86586a966202b5aa4aed31633f330aba"

String

metadataPartition
optional

The ID of the metadata partition.

Example: -1

Integer

numReplicas
optional

The number of Analytics replicas.

Example: 1

Integer

revision
optional

The revision number of the partition topology.

Example: 1

Integer

version
optional

The version number of the partition topology.

Example: 1

Integer

partitions
optional

An array of objects, each giving information about the state of one Analytics partition.

Partition States

[brackets curly] Object

Property Schema

id
optional

The partition ID.

Example: 0

Integer

master
optional

The ID of the node where the partition is currently active.

Example: "86586a966202b5aa4aed31633f330aba"

String

origin
optional

The ID of the node where the partition originated.

Example: "86586a966202b5aa4aed31633f330aba"

String

replicas
optional

An array of objects, each giving information about the state of one Analytics replica.

Replicas array

Replicas

[brackets curly] Object

Property Schema

location
optional

The name or IP address of the node where this replica is located, including the Analytics replication port.

Example: "192.168.8.102:9120"

String

nodeId
optional

The ID of the node where this replica is located.

Example: "948fb3af810a9b7bc6c76e2a69ba35d9"

String

status
optional

The synchronization status of the replica.

Values: "IN_SYNC", "CATCHING_UP", "DISCONNECTED"
Example: "IN_SYNC"

String

syncProgress
optional

The percentage (fraction from 0 to 1) of synchronization progress for this replica at the current time.

Minimum: 0
Maximum: 1
Example: 1

Double (double)

Security

Analytics Manage / Analytics Select

For the [Active Requests](#return_active_requests), [Request Cancellation](#cancel_request), [Completed Requests](#completed_requests), [Ingestion Status](#ingestion_status), and [Pending Mutations](#monitor_node) operations, users must have one of the following access roles:

  • Full Admin

  • Cluster Admin

  • Analytics Manager

  • Analytics Reader

  • Analytics Select

  • Analytics Admin

Type: http

Cluster Read / Pools Read

For the [Cluster Status](#cluster_status) operation, users must have one of the following access roles:

  • Full Admin

  • Cluster Admin

  • Read-Only Admin

  • Analytics Admin

Type: http

Analytics Manage

For the [Cluster Restart](#restart_cluster) and [Node Restart](#restart_node) operations, users must have one of the following RBAC roles:

  • Full Admin

  • Cluster Admin

  • Analytics Admin

Type: http