API docs by Redocly

Enterprise Analytics Administration REST APIs (2.0)

Download OpenAPI specification:

These APIs enables you to manage and monitor the Enterprise Analytics Service.

Request Cancellation

Cancels an active request.

Authorizations:
AnalyticsManageAnalyticsAccess
Request Body schema: application/x-www-form-urlencoded
client_context_id
required
string

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

Responses

Response samples

Content type
application/json
{ }

Active Requests

Gets a list of the analytic requests that are running.

Authorizations:
AnalyticsManageAnalyticsAccess

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Completed Requests

Gets a list of all completed analytic requests.

Authorizations:
AnalyticsManageAnalyticsAccess

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service Status

Shows various details about the current status of the Enterprise Analytics Service, such as the service state, and the state of each node partition.

Authorizations:
ClusterReadPoolsRead

Responses

Response samples

Content type
application/json
{
  • "authorizedNodes": [
    ],
  • "ccNodeId": "86586a966202b5aa4aed31633f330aba",
  • "nodeConfigUri": "/api/v1/config/node",
  • "nodeDiagnosticsUri": "/api/v1/node/diagnostics",
  • "nodeRestartUri": "/api/v1/node/restart",
  • "serviceRequestUri": "/api/v1/request",
  • "serviceConfigUri": "/api/v1/config/service",
  • "serviceRestartUri": "/api/v1/service/restart",
  • "state": "ACTIVE",
  • "nodes": [],
  • "partitions": [
    ],
  • "partitionsTopology": {
    }
}

Service Restart

Restarts the Enterprise Analytics Service in all nodes in the cluster.

Authorizations:
AnalyticsManage

Responses

Response samples

Content type
application/json
{ }

Node Restart

Restarts the Enterprise Analytics Service on the target node.

Authorizations:
AnalyticsManage

Responses

Response samples

Content type
application/json
{ }

Ingestion Status

Shows the progress of ingestion for each collection.

Authorizations:
AnalyticsManageAnalyticsAccess

Responses

Response samples

Content type
application/json
{
  • "links": [
    ]
}