Kyvos Manager

Download OpenAPI specification:Download

Kyvos Manager Rest API Documentation

Find out more about Kyvos mailto:support@kyvos.io

Services

The Services module of Kyvos Manager provides you REST APIs for start/stop/restart the services of cluster. In this module you can start/stop/restart single service, group of service, all services etc.

Start/Stop/Restart Cluster Services

This API is used to start, stop, or restart all the cluster services.

The response of the API call displays the Operation ID of the services operation. To get the status of the operation, use the API Get Single Operation Details or use the Get Operation Logs API to view the operation logs.

Authorizations:

basicAuth

path Parameters

action

required

string

Enum: "start" "stop" "restart"

The action name to be performed on cluster services.

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 23
},
"STATUS": 200,
"MESSAGE": "The request to start, stop, or restart cluster services has been accepted.",
"ERRORS": null
}

Start/Stop/Restart Specific Service

This API is used to start, stop, or restart a specific cluster service on the cluster.

For Kyvos Manager services, only restart action is available. Before serving this request, the API does not check if any operation is in progress for this request. The request aborts the operation in progress and restarts the Kyvos Manager application. The response does not show any operation ID.

For Kyvos services, the API will start, stop, or restart the BI Server, Query Engine, Web Portal, and Postgres Server services. It doesn't perform any action if Kyvos Manager is using the same Postgres Server service.

The response of the API call displays the Operation ID of the start/stop/restart cluster services operation. To get the status of the operation, use the API Get Single Operation Details or use the Get Operation Logs API to view the operation logs.

Authorizations:

basicAuth

path Parameters

serviceName required	string Enum: "BISERVER" "QUERYENGINE" "WEBPORTAL" "POSTGRESSERVER" "STANDBYPOSTGRESSERVER" "KMAGENT" "ZOOKEEPER" "KYVOS" "KYVOSMANAGER" The name of service which you want to start/stop/restart.
action required	string Enum: "start" "stop" "restart" The action name to be performed on cluster services.

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 23
},
"STATUS": 200,
"MESSAGE": "The request to start, stop, or restart service has been accepted.",
"ERRORS": null
}

Start/Stop/Restart Given Node Services

This API is used to start, stop, or restart all the services configured on a specific node.

The response of the API call displays the Operation ID of the start/stop/restart cluster services operation. To get the status of the operation, use the API Get Single Operation Details or use the Get Operation Logs API to view the operation logs.

Authorizations:

basicAuth

path Parameters

node required	string The IP/hostname of node which is configured in the cluster.
action required	string Enum: "start" "stop" "restart" The action name to be performed on cluster services.

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 23
},
"STATUS": 200,
"MESSAGE": "The request to start, stop, or restart service has been accepted.",
"ERRORS": null
}

Start/Stop/Restart Given Services on Node

This API is used to start, stop, or restart a specific cluster service on a specific node.

The response of the API call displays the Operation ID of the start/stop/restart cluster services operation. To get the status of the operation, use the API Get Single Operation Details or use the Get Operation Logs API to view the operation logs.

Authorizations:

basicAuth

path Parameters

node required	string Example: 172.25.4.3 The IP/hostname of node which is configured in the cluster.
serviceName required	string Enum: "BISERVER" "QUERYENGINE" "WEBPORTAL" "POSTGRESSERVER" "STANDBYPOSTGRESSERVER" "KMAGENT" "ZOOKEEPER" "KYVOS" "KYVOSMANAGER" The name of service which you want to start/stop/restart.
action required	string Enum: "start" "stop" "restart" The action name to be performed on cluster services.

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 23
},
"STATUS": 200,
"MESSAGE": "The request to start, stop, or restart service has been accepted.",
"ERRORS": null
}

Node

Kyvos Manager supports increasing and decreasing cluster capacity through REST APIs. Using the REST APIs, you can add or delete nodes of BI Server and Query Engines.

Get Nodes Details

This API is used to fetch details of nodes available in the cluster.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

nodes	Array of strings Array of nodes IP/hostname available in the cluster for which you want to fetch details.
services	Array of strings Array of cluster services for which you want to fetch details.

Responses

Request samples

Payload

Content type

application/json

Example

Fetch Details by Node

{"nodes": ["localhost",
"127.0.0.1"
]
}

Response samples

200
401

Content type

application/json

{"OUTPUT": {"127.0.0.1": {"host": "127.0.0.1",
"publicHost": "127.0.0.1",
"monitor": null,
"id": 1685506276021,
"datacenter": null,
"rack": null,
"os": "CentOS",
"status": true,
"state": "DEPLOYED",
"errors": { },
"roles": {"Kyvos": ["WebPortal",
"OLAPEngine",
"Postgres-Server"
]
},
"params": null,
"service": {"WEBPORTAL": ["WebPortal"
],
"BISERVER": ["OLAPEngine"
],
"POSTGRESSERVER": ["Postgres-Server"
]
}
}
},
"STATUS": 200,
"MESSAGE": "The request to get node details request has been accepted.",
"ERRORS": null
}

Add Nodes for a Single Kyvos Service

This API is used to add nodes for a single Kyvos service. Here Kyvos Service means BI Server or Query Engine. Using this API, you can add nodes for BI Server or Query Engines.

The response of the API call shows the Operation ID of the add node operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

nodes required	Array of strings Array of node IP/hostname that you want to add to the cluster.
service required	string Enum: "BISERVER" "QUERYENGINE" Service for which you want to add the nodes. It can be BISERVER or QUERYENGINE.

Responses

Request samples

Payload

Content type

application/json

{"service": "BISERVER/QUERYENGINE",
"nodes": ["1.2.3.4",
"host-name",
"custom-host-name"
]
}

Response samples

202
401

Content type

application/json

{"OUTPUT": {"operationId": 15
},
"STATUS": 202,
"MESSAGE": "The request to add node has been accepted.",
"ERRORS": null
}

Delete Nodes

This API is used to delete one or more nodes from the cluster. You cannot delete the node from a single-node cluster. Also, deletion of the Web Portal node, Standby Postgres Server node, Postgres Server node, and BI Server (single node) is not allowed.

The response of the API call shows the Operation ID of the delete node operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

nodes

Array of strings

Array of IP/hostnames of the nodes to be deleted from cluster.

Responses

Request samples

Payload

Content type

application/json

{"nodes": ["1.2.3.4",
"host-name",
"custom-host-name"
]
}

Response samples

200
401

Content type

application/json

{"OUTPUT": {"operationId": 18
},
"STATUS": 200,
"MESSAGE": "The request to delete node has been accepted.",
"ERRORS": null
}

Add Nodes for Multiple Kyvos Services

This API is used to add nodes to multiple Kyvos services in one go. Using this API, you can add nodes for both BI Server and Query Engines in a single call.

The response of the API call shows the Operation ID of the add node operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

required

object

The object IP/hostnames of the nodes to be added along with the corresponding service name array.

Responses

Request samples

Payload

Content type

application/json

{"nodes": {"110.100.10.168": {"service": ["BISERVER",
"QUERYENGINE"
]
},
"110.100.10.166": {"service": ["BISERVER"
]
},
"110.100.10.167": {"service": ["QUERYENGINE"
]
}
}
}

Response samples

202
401

Content type

application/json

{"OUTPUT": {"operationId": 19
},
"STATUS": 202,
"MESSAGE": "The request to add node has been accepted.",
"ERRORS": null
}

Query Engine Segments

Kyvos Manager REST APIs allow you to add, delete, and update the Query Engine based segments.

Get All Segments

This API is used to fetch details of all the configured segments in the cluster. The response consists of an array containing segment objects including segment name, segment type, and the details of associated Query Engine instances.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": [{"NAME": "Segment-2",
"SEGMENTTYPE": 0,
"QUERYENGINE": ["110.10.10.100:QueryEngine-Instance2"
]
},
{"NAME": "Segment-1",
"SEGMENTTYPE": 0,
"QUERYENGINE": ["110.10.10.100:QueryEngine"
]
}
],
"STATUS": 200,
"MESSAGE": "The request to get segment details has been accepted.",
"ERRORS": null
}

Add Query Engine Based Segment

This API is used to add Query Engine based segment. You can add multiple Query Engines in a single segment.

The response of the API call shows the Operation ID of the add segments operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

NAME	string Unique Query Engine segment name. If a name is not provided, an auto-generated name will be used.
QUERYENGINE required	Array of strings Array of distinct Query Engine nodes. Provide in IP Address:QueryEngine-Instance format.

Responses

Request samples

Payload

Content type

application/json

Example

Add Query Engine Segment

[{"NAME": "segmentName",
"QUERYENGINE": ["110.10.10.100:QueryEngine-Instance",
"110.10.10.101:QueryEngine-Instance"
]
}
]

Response samples

202
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 6
},
"STATUS": 202,
"MESSAGE": "The request to add segments request has been accepted.",
"ERRORS": null
}

Update Query Engine Based Segments

This API is used to update the Query Engine based segments. While updating a segment, all the Query Engines associated with the segment are replaced with new Query Engines. The system will show an error if you provide any currently associated Query Engine.

The response of the API call shows the Operation ID of the update segments operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

NAME required	string Name of the segment to be updated.
QUERYENGINE required	Array of strings Array of distinct Query Engine nodes to be added to the segment. Provide in IP Address:QueryEngine-Instance format.

Responses

Request samples

Payload

Content type

application/json

[{"NAME": "segmentName",
"QUERYENGINE": ["110.10.11.100:QueryEngine-Instance"
]
}
]

Response samples

202
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 7
},
"STATUS": 202,
"MESSAGE": "The request to update segments request has been accepted.",
"ERRORS": null
}

Delete Multiple Segments

This API is used to delete multiple segments from the cluster.

The response of the API call shows the Operation ID of the delete segments operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

name	Array of strings Array of names of the segments to be deleted.

Responses

Request samples

Payload

Content type

application/json

{"name": ["segmentName1",
"segmentName2"
]
}

Response samples

200
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 7
},
"STATUS": 200,
"MESSAGE": "The request to delete segments request has been accepted.",
"ERRORS": null
}

Get Segment File Data

This API is used to get the segment file data.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"segmentsInfo": {"Segment-2": {"segmentID": 1685344188448,
"segmentType": 0,
"queryEngines": ["110.10.10.100:QueryEngine-Instance2"
]
},
"Segment-1": {"segmentID": 1685344162918,
"segmentType": 0,
"queryEngines": ["110.10.10.100:QueryEngine"
]
}
}
},
"STATUS": 200,
"MESSAGE": "The request to get segment file detail has been accepted.",
"ERRORS": null
}

Get Single Segment

This API is used to fetch a single segment from the cluster.

Authorizations:

basicAuth

path Parameters

segmentName

required

string

Name of the segment to be fetched.

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": [{"NAME": "Segment-2",
"SEGMENTTYPE": 0,
"QUERYENGINE": ["110.10.10.100:QueryEngine-Instance2"
]
}
],
"STATUS": 200,
"MESSAGE": "The request to get segment details has been accepted.",
"ERRORS": null
}

Delete Single Segment

This API is used to delete a single segment from the cluster.

The response of the API call shows the Operation ID of the delete segments operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:

basicAuth

path Parameters

segmentName

required

string

Name of the segment to be deleted.

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 7
},
"STATUS": 200,
"MESSAGE": "The request to delete segments request has been accepted.",
"ERRORS": null
}

Add Query Engine nodes to Segment

This API is used to add Query Engine nodes to a Query Engine based segment.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

NAME required	string Name of the Query Engine based segment to which you want to add a new node.
QUERYENGINE required	Array of strings Array of IP Addresses of the Query Engine nodes to be added to the segment. Provide in IP Address: QueryEngine-Instance format.

Responses

Request samples

Payload

Content type

application/json

[{"NAME": "segmentName",
"QUERYENGINE": ["110.10.10.100:QueryEngine-Instance"
]
}
]

Response samples

202
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 9
},
"STATUS": 202,
"MESSAGE": "The request to add node in segment has been accepted.",
"ERRORS": null
}

Delete Query Engine Nodes from Segment

This API is used to delete Query Engine nodes from a Query Engine based segment.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

NAME required	string Name of the Query Engine based segment from which you want to delete the Query Engine node.
QUERYENGINE required	Array of strings Name of the Query Engine node to be deleted from the Query Engine based segment.

Responses

Request samples

Payload

Content type

application/json

[{"NAME": "segmentName",
"QUERYENGINE": ["110.10.10.100:QueryEngine-Instance"
]
}
]

Response samples

200
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 10
},
"STATUS": 200,
"MESSAGE": "The request to delete node in segment has been accepted.",
"ERRORS": null
}

Get Nodes Details for Segment

This API is used to fetch details of all the nodes available in the cluster that can be added to segments.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"localhost:QueryEngine": {"volumes": [{"limit": 45,
"path": "/home/kyvos/cluster/cube_local_cache/",
"diskType": 1
}
]
},
"localhost:QueryEngine-Instance2": {"volumes": [{"limit": 45,
"path": "/home/kyvos/cluster/cube_local_cache/",
"diskType": 1
}
]
}
},
"STATUS": 200,
"MESSAGE": "The request to get the resources details has been accepted.",
"ERRORS": null
}

Application Update

Kyvos Manager REST APIs allow you to upgrade,rollback and apply patch on the application.

Upgrade Version Listing

This API is used to get the list of compatible versions available for upgrading Kyvos and Kyvos Manager. The list of available bundles is only supported for Azure clusters, including Azure Marketplace-based deployments. For clusters deployed through Azure Marketplace, you do not need to provide Client Secret in the request body.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

clientSecret

string

Client secret is used to fetch the available upgrade bundles for the listing from the Azure storage.

Responses

Request samples

Payload

Content type

application/json

{"clientSecret": "string"
}

Response samples

200
401

Content type

application/json

{"OUTPUT": ["2023.2.1",
"2023.3"
],
"STATUS": 200,
"MESSAGE": "The upgrade bundles listing request has been accepted.",
"ERRORS": null
}

Upgrade Kyvos and Kyvos Manager

This API is used to upgrade Kyvos and Kyvos Manager in one go or separately. However, to upgrade the Kyvos version separately, you must first upgrade the Kyvos Manager.

You can use version parameter to upgrade Kyvos and Kyvos Manager in a single call for Azure deployments.

To upgrade Kyvos Manager separately use either the upgradeBundlePath or the version parameter. To upgrade Kyvos only, use the upgradeBundlePath parameter.

Version parameter is supported for Cloud deployments only.

The response of application update API call shows the Operation ID of the upgrade operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

component required	string Enum: "All" "Kyvos" "KyvosManager" Component to be upgraded. All: Upgrades both Kyvos and Kyvos Manager. Kyvos: Upgrades only Kyvos. Kyvos Manager: Upgrades only Kyvos Manager.
version required	string Version to which you want to upgrade. This parameter is supported only when upgrading either Kyvos Manager or both Kyvos and Kyvos in one go.
upgradeBundlePath required	string Path where the upgrade bundle is available on the Kyvos Manager machine.
startServices	boolean Set as `true` to restart all the Kyvos services automatically after the upgrade. If this is `false`, you need to manually restart Kyvos services after the upgrade. The default value is `true`.
backupCubeData	boolean Set as `true` to create a backup of the cube data before upgrade. If the parameter is blank, it is considered as `false`, and no cube data backup will be created. The default value is `false`.
backupLogs	boolean Set as `true` to create a backup of the monitoring logs. The default value is `false`.
upgradeBehaviorTemplateOverwrite	boolean Set as `true` to override the email template data. The default value is `false`.
clientSecret	string Client secret to download the upgrade bundle from the Azure storage. This is a mandatory input if upgrading All components or Kyvos Manger using the version option on the Azure platform.
accessKeyId	string Access key ID for AWS/GCP to download the upgrade bundle from S3/Google storage. This is a mandatory input if upgrading All components or Kyvos Manger using the version option on the AWS platform.
secretAccessKey	string Secret access key for AWS/GCP to download the upgrade bundle from S3/Google storge. This is a mandatory input if upgrading All components or Kyvos Manger using the version option on the AWS/GCP platform.

Responses

Request samples

Payload

Content type

application/json

Example

Kyvos Manager and Kyvos both upgrade in Azure

{"component": "All",
"version": "2023.2",
"clientSecret": "xxxxxxxxxxxxxx",
"startServices": true,
"backupCubeData": true
}

Response samples

202
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 4
},
"STATUS": 202,
"MESSAGE": "The application upgrade request accepted.",
"ERRORS": null
}

Patch Version Listing

This API is used to get the list of compatible versions for patch upgrades of the Kyvos application. The list of available bundles is only supported for clusters deployed through the Azure Marketplace.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": ["2023.2.1_Patch075.18",
"2023.3_Patch077.23"
],
"STATUS": 200,
"MESSAGE": "The patch bundles listing request has been accepted.",
"ERRORS": null
}

Apply Patch for Kyvos

This API is used to apply patches on Kyvos. Users can use version and patchBundlePath parameters to apply patches on Kyvos.

Version parameter is supported for clusters deployed through Azure Marketplace only. To get the list of patch bundles, use the Patch Version Listing API.

The response of the API call displays the Operation ID of the patch operation. To get the status of the operation, use the Get Single Operation Details API or use the Get Operation Logs API to view the operation logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

version	string Version to which you want to apply patch on Kyvos. This parameter is supported only when apply patch from the marketplace deployment.
patchBundlePath	string Path where the patch bundle is available on the Kyvos Manager machine.
startServices	boolean Set as `true` to restart all the Kyvos services automatically after the patch. If this is `false`, you need to manually restart Kyvos services after the upgrade. The default value is `true`.
backupCubeData	boolean Set as `true` to create a backup of the cube data before upgrade. If the parameter is blank, it is considered as `false`, and no cube data backup will be created. The default value is `false`.
backupLogs	boolean Set as `true` to create a backup of the monitoring logs. The default value is `false`.

Responses

Request samples

Payload

Content type

application/json

Example

Apply Patch in marketplace based deployment

{"version": "2023.2_Patch075.18",
"startServices": true,
"backupCubeData": true,
"backupLogs": true
}

Response samples

202
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 4
},
"STATUS": 202,
"MESSAGE": "The apply patch request has been accepted.",
"ERRORS": null
}

Rollback Bundle Listing

This API is used to get the list of available bundles to rollback to previous versions of Kyvos and Kyvos Manager.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": [{"upgradedOn": "2023-07-18 17:47:58.474",
"bundleName": "Kyvos2023.2_Build137.031_ux64.tar.gz"
}
],
"STATUS": 200,
"MESSAGE": "The rollback bundles listing request has been accepted.",
"ERRORS": null
}

Rollback Application

This API is used to rollback Kyvos and Kyvos Manager simultaneously. Simultaneous rollback of both Kyvos and Kyvos Manager is supported only for the clusters deployed through Azure Marketplace. Use the Rollback Bundle Listing API to get the list of rollback bundles.

The response of the API call displays the Operation ID of the rollback operation. To get the status of the operation, use the Get Single Operation Details API or use the Get Operation Logs API to view the operation logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Request Body schema: application/json

component required	string Enum: "All" "Kyvos" Component to be rollback. All: Rollback both Kyvos and Kyvos Manager. Kyvos: Rollback only Kyvos.
rollbackName required	string The rollback bundle name to which you want to rollback the Kyvos.
startServices	boolean Set as `true` to restart all the Kyvos services automatically after the rollback. If this is `false`, you need to manually restart Kyvos services after the rollback. The default value is `true`.

Responses

Request samples

Payload

Content type

application/json

Example

Rollback in marketplace based deployment

{"component": "All",
"rollbackName": "Kyvos2023.2_Patch087.027_ux64.tar.gz",
"startServices": true
}

Response samples

202
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 4
},
"STATUS": 202,
"MESSAGE": "The application rollback request has been accepted.",
"ERRORS": null
}

Operations

The Operations module of Kyvos Manager monitors user activities on the cluster. You can use the Kyvos Manager REST APIs to get the operation details, logs, and so on.

Get All Operations Details

This API is used to fetch details of all the operations performed on the cluster.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"currentServerTime": 1685962184330,
"operations": [{"opDisplayName": "Configure Server Details",
"completedAt": 1685506774674,
"data": {"input": null,
"errCount": 0,
"warnCount": 2,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685506758506,
"operationId": 2,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685509977782,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685509958516,
"operationId": 5,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685508579729,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685508558959,
"operationId": 3,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Kyvos Manager Restart",
"completedAt": 1684678015848,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "admin",
"opName": "KYVOS MANAGER RESTART",
"startedAt": 1684678001335,
"operationId": 4,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Kyvos Manager Restart",
"completedAt": 1685510523987,
"data": {"input": null,
"errCount": 1,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "admin",
"opName": "KYVOS MANAGER RESTART",
"startedAt": 1685510420900,
"operationId": 6,
"clusterId": 1685506275997,
"status": "ABORTED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685510545116,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685510524103,
"operationId": 7,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Cluster Deploy",
"completedAt": 1685506365403,
"data": {"input": {"clusterId": 1685506275997,
"name": "KyvosCluster",
"createdBy": "admin",
"hosts": "127.0.0.1",
"hostFile": "",
"technology": "Hybrid",
"operationId": 1,
"state": "DEPLOYED",
"authConf": {"username": "kyvos",
"password": "wy7XiFV7iAcdPyEe+kl+tEn6oSHJKF0xmED9VbpjIFJ2+diQiotmOVTqviRQbTUvAUQz",
"privateKey": null,
"usingPassword": true,
"externalyStored": false,
"encrypted": true,
"encryptionAlgo": "AES_128_GCM"
},
"javaConf": null,
"nodes": {"127.0.0.1": {"host": "127.0.0.1",
"publicHost": "127.0.0.1",
"monitor": null,
"id": 1685506276021,
"datacenter": null,
"rack": null,
"os": "CentOS",
"status": true,
"state": "DEPLOYED",
"errors": { },
"roles": {"Kyvos": ["WebPortal",
"OLAPEngine",
"Postgres-Server"
]
},
"params": null
}
},
"installationType": "NONSUDO",
"components": {"Agent": {"confState": null,
"vendor": null,
"version": null,
"source": null,
"sourceType": null,
"installPath": "/home/kyvos/OnPremTemp1/",
"register": false,
"homeDir": "/home/kyvos/OnPremTemp1/kyvosmanagerdata/agent/",
"state": null,
"nodes": null,
"advanceConf": {"jmxPortAgent": 2121
}
},
"Kyvos": {"confState": "custom",
"vendor": null,
"version": "2023.2",
"source": "/home/kyvos/bundle/kyvosmanager_war/kyvosmanagerdata/server/repo/Kyvos2023.2_Build087.027_ux64.tar.gz",
"sourceType": "UPLOAD",
"installPath": "/home/kyvos/OnPremTemp1/",
"register": false,
"homeDir": "/home/kyvos/OnPremTemp1/kyvos/",
"state": null,
"nodes": {"127.0.0.1": {"instancesCountOLAPEngine": 1
}
},
"advanceConf": {"hadoopMetadata": {"vendor": "APACHE",
"fileSystemType": "HDFS",
"bucketName": "",
"hdInsightHome": "",
"version": "3.2",
"mapRedType": "YARN",
"nameNodeIP": "localhost",
"nativeLibInclusionPaths": "/home/kyvos/OnPremTemp1",
"libInclusionPaths": "/home/kyvos/OnPremTemp1",
"confInclusionPaths": "/home/kyvos/OnPremTemp1",
"zkConnectStr": "localhost:2181",
"useDifferentLogin": false,
"hadoop2": true,
"createLink": false
},
"authConf": {"hadoopSecurityType": "SIMPLE",
"renewableTicketsCheck": false,
"envSetupCheck": false,
"keyTabCheck": false,
"keyTabFile": null,
"keyTabUserName": "",
"authType": "NATIVE",
"userCreationTypeFirstLogin": "LDAP",
"authSystem": "LDAP",
"kerberosType": "ACTIVE DIRECTORY",
"ldapConf": {"LDAP-1682944723315": {"alias": "LDAP-1682944723315",
"referral": "follow",
"directoryType": "MICROSOFT ACTIVE DIRECTORY",
"hostName": "localhost",
"port": 389,
"userName": "",
"password": "",
"syncInterval": 60,
"readTimeout": 120,
"searchTimeout": 60,
"connectionTimeout": 0,
"baseDN": "",
"additionalUserDN": "",
"additionalGroupDN": "",
"userRole": 3,
"groupImportType": "",
"userGroupSyncLevel": "INCREMENTAL",
"useSSL": false,
"certificateFile": "",
"userFilter": "",
"groupFilter": "",
"customAttributesLDAP": { },
"original": true
}
},
"kerberosServer": "",
"kerberosRealm": "",
"kbLoginInfoMode": "File Upload",
"kbLoginInfo": "",
"kbLoginInfoFilePath": null,
"enableSSO": false,
"singleSignOnProvider": "JESPA",
"bindStr": "",
"dnsServer": "",
"computerAccountName": "",
"computerAccountPassword": "",
"encJespaPassword": false,
"jespaJar": null,
"jespaVersion": "1.2.5",
"jcifsJar": null,
"enableKBSSO": false,
"serviceKBSSO": "",
"domainKBSSO": "",
"realmKBSSO": "",
"fileKRB5KBSSO": "/etc/krb5.conf",
"sourceKeyTabFileKBSSO": 0,
"keyTabFilePathKBSSO": null,
"authorizationType": "NONE",
"hadoopAccessMethod": 0,
"keyTabFilePath": "",
"keyTabFileName": "",
"encryptionAlgoName": "AES_128_GCM"
},
"executionEngineName": "mr",
"executionEngineLibPath": "",
"executionEngineConfPath": "",
"sparkVersion": "",
"sparkMode": "yarn-cluster",
"homePathSpark": "",
"libPathSpark": "",
"confPathSpark": "",
"sparkSourceNode": 1,
"sparkNodeIP": "",
"sparkUsesDifferentLogin": false,
"sparkConnCustomParams": [ ],
"memoryUnit": "G",
"appMasterMemoryUnit": "G",
"appMasterRestartStyle": 0,
"replicationType": "NONE",
"backupPath": "/home/kyvos/OnPremTemp1",
"ensembleId": "default",
"activeDatabaseName": "POSTGRES",
"cubeLocalPath": "/home/kyvos/OnPremTemp1/cube_local_cache/",
"nfsCachePath": "",
"storageGatewayDetails": "",
"enablePostgresHA": false,
"postgresHAWaitInterval": 3,
"launchBIServer": false,
"startServices": false,
"enableServicesHA": true,
"installDatabase": true,
"libConfSetupStyle": 1,
"enableSnappy": false,
"nativeLibPathSnappy": "",
"enableLZO": false,
"nativeLibPathLZO": "",
"libPathLZO": "",
"deployOnYARN": true,
"ascType": "k8s",
"scalingMode": "SCHEDULED",
"fsType": "EFS",
"fsPort": 19998,
"fsWebUIPort": 19999,
"fsSetup": true,
"awsAccountId": "",
"awsRegion": "",
"fsDNS": "",
"configureAutoScalingActions": false,
"executeTerraform": false,
"defaultQEInstances": 1,
"nfsMountPoint": "/efs/",
"storageGatewayMountPoint": "/storage_gateway",
"s_i_threshold": 30000,
"s_o_threshold": 60000,
"dataPointValue": 1,
"qeCount": 1,
"oeCount": 1,
"notificationEmailRecipients": "support@kyvos.io",
"cores": 2,
"memory": 8,
"queueName": "default",
"appMasterVCores": 2,
"appMasterMemory": "4",
"qeLogsSyncInterval": 30,
"qeLogPath": "./logs",
"appMasterLogPath": "/tmp/KyvosCluster",
"yarnJobName": "KyvosQEYARN",
"qeOperationMode": 0,
"qeScaleUpTime": "10:00",
"qeScaleDownTime": "22:00",
"enableQEAutoScale": false,
"qeHostNames": "",
"minQECount": 0,
"minQEHostNames": "",
"maxMemoryWP": "2",
"maxMemoryQE": "4",
"maxMemoryOE": "4",
"offHeapMemoryQE": "2",
"additionaljvmOptionsOE": "-XX:+UseG1GC -XX:MaxMetaspaceSize=500m -XX:-OmitStackTraceInFastThrow -XX:+HeapDumpOnOutOfMemoryError -XX:+DisableExplicitGC -Dsun.zip.disableMemoryMapping=true",
"additionaljvmOptionsQE": "-XX:+UseG1GC -XX:MaxMetaspaceSize=500m -XX:-OmitStackTraceInFastThrow -XX:+HeapDumpOnOutOfMemoryError",
"additionaljvmOptionsWP": "",
"maxMemoryQEUnit": "G",
"maxMemoryOEUnit": "G",
"maxMemoryWPUnit": "G",
"offHeapMemoryQEUnit": "G",
"useConfiguredHadoopValues": true,
"databaseNode": "",
"jmxPortOLAPEngine": 6602,
"jmxPortQueryEngine": 6702,
"jmxPortWebPortal": 6605,
"jmxPortLoadBalancer": 6604,
"listenerPortOLAPEngine": 45450,
"thriftListenerPortQueryEngine": 45440,
"registryListenerPortLoadBalancer": 60000,
"uiPortWebPortal": 8081,
"multicastAddress": "228.0.0.4",
"enableWebPortalHA": false,
"multicastPort": 45564,
"virtualHostName": "",
"receiverPort": 4000,
"shutdownPort": 8005,
"license": "/home/kyvos/bundle/kyvosmanager_war/kyvosmanagerdata/server/uploads/dCHoSAk7ncVUJ49Z5Q101685506244181/olapengine(3).lic",
"ajpPort": 8009,
"loadBalancerEnabled": false,
"workDir": "/user/engine_work/",
"defaultConnectionName": "DefaultHadoopCluster01",
"defaultRepositoryName": "DemoRepositoryDB",
"hadoopConnCustomParams": [ ],
"enableHCatalog": false,
"datasourceHive": false,
"libPathHCatalog": "",
"confPathHCatalog": "",
"hiveSourceNode": 0,
"hiveVersion": "",
"hiveUsesDifferentLogin": false,
"hcatalogConnCustomParams": [ ],
"showEnableTLSWarning": false,
"tlsConf": {"enableTLS": false,
"enableHTTPS": false,
"httpProtocolVersion": "1.0",
"customAttributes": { },
"useDifferentPortalCert": false
},
"deployedBundleName": "Kyvos2023.2_Build087.027_ux64.tar.gz",
"abfsAccountName": "",
"orgId": "",
"databricksUrl": "",
"computeClusterAuthType": "MANAGED_IDENTITY",
"keyVaultURL": "",
"useKeyVault": true,
"databricksAccessToken": "",
"databricksClusterId": "",
"useSSHForComputeCluster": true,
"enableLivy": false,
"hiveNodeIP": "localhost",
"hiveNodeAuthConf": {"username": "",
"usingPassword": false,
"privateKey": ""
},
"sparkNodeAuthConf": {"username": "",
"usingPassword": false,
"privateKey": ""
},
"paramsSpark": { },
"appMasterRestartSchedule": { },
"configureSessionReplication": false,
"syncConf": true,
"syncLib": true,
"ss": true
}
}
},
"data": {"kmVersion": "2023.2.R17",
"installPath": "/home/kyvos/OnPremTemp1",
"platform": "ON_PREM",
"cloudProvider": "AWS",
"managedServiceDeployment": false
},
"errors": { }
},
"errCount": 1,
"warnCount": 6,
"progress": {"state": "WAITING",
"progress": 0,
"breakup": {"Agent": {"state": "WAITING",
"progress": 0,
"breakup": { }
},
"Kyvos": {"state": "WAITING",
"progress": 0,
"breakup": { }
}
}
}
},
"startedBy": "admin",
"opName": "DEPLOY",
"startedAt": 1685506276054,
"operationId": 1,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685516557885,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685516538605,
"operationId": 8,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685523259599,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685523249501,
"operationId": 9,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Kyvos YARN Options",
"completedAt": 1685533017296,
"data": {"input": {"appMasterRestartRequested": false
},
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "admin",
"opName": "CONFIGURE KYVOS YARN OPTIONS",
"startedAt": 1685533016624,
"operationId": 13,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685527966381,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685527946365,
"operationId": 10,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685531757381,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685531736223,
"operationId": 12,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685530196206,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685530184358,
"operationId": 11,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685536602097,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685536582756,
"operationId": 14,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Hadoop Ecosystem",
"completedAt": 1685590697486,
"data": {"input": {"restoreBILibs": false,
"syncLib": true,
"libConfSetupStyle": 1,
"syncConf": true
},
"errCount": 3,
"warnCount": 5,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "admin",
"opName": "CONFIGURE HADOOP ECOSYSTEM",
"startedAt": 1685590609903,
"operationId": 15,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685690755439,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685690736000,
"operationId": 18,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685681691534,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685681668712,
"operationId": 16,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685682310101,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685682291544,
"operationId": 17,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Upgrade Kyvos",
"completedAt": 1685697334647,
"data": {"input": {"upgradeBehaviorTemplateOverwrite": false,
"backup": true,
"upgradeBehaviorConfOverwrite": false,
"upgradeBehaviorDataOverwrite": false,
"startServices": true,
"backupCubeData": false,
"component": "Kyvos",
"upgradeBehaviorLicenseOverwrite": false,
"backupPath": "/home/kyvos/OnPremTemp1/",
"action": "UPGRADE DEPLOY",
"from": "Kyvos2023.2_Build087.027_ux64.tar.gz",
"bundle": "Kyvos2023.1_Build087.027_ux64.tar.gz",
"backupLogs": false
},
"errCount": 2,
"warnCount": 1,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "admin",
"opName": "UPGRADE DEPLOY",
"startedAt": 1685697142223,
"operationId": 20,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685692154605,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685692131812,
"operationId": 19,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685703540018,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685703513454,
"operationId": 21,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685949417405,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685949396757,
"operationId": 22,
"clusterId": 1685506275997,
"status": "COMPLETED"
},
{"opDisplayName": "Configure Server Details",
"completedAt": 1685957781291,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685957754398,
"operationId": 23,
"clusterId": 1685506275997,
"status": "COMPLETED"
}
],
"status": true
},
"STATUS": 200,
"MESSAGE": "The request to get the operation details has been accepted.",
"ERRORS": null
}

Get Single Operation Details

This API is used to fetch the details of a specific operation ID. The response includes operation name, errors, warning, execution status, start time, end time, and so on.

Authorizations:

basicAuth

path Parameters

operationId

required

string

Operation ID for which you want to fetch details.

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"currentServerTime": 1685962082229,
"operations": [{"opDisplayName": "Configure Server Details",
"completedAt": 1685957781291,
"data": {"input": null,
"errCount": 0,
"warnCount": 0,
"progress": {"state": "COMPLETED",
"progress": 100,
"breakup": {"Agent": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
},
"Kyvos": {"state": "COMPLETED",
"progress": 100,
"breakup": { }
}
}
}
},
"startedBy": "AUTO TRIGGERED",
"opName": "CONFIGURE SERVER DETAILS",
"startedAt": 1685957754398,
"operationId": 23,
"clusterId": 1685506275997,
"status": "COMPLETED"
}
],
"status": true
},
"STATUS": 200,
"MESSAGE": "The request to get the operation details has been accepted.",
"ERRORS": null
}

Get Operation Logs

This API is used to fetch the logs of a specific operation ID. The logs provide details of the steps performed for operation execution and details of operation failure, if any.

Authorizations:

basicAuth

path Parameters

operationId

required

string

Operation ID for which you want to fetch logs.

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"nodes": ["127.0.0.1"
],
"operationState": "COMPLETED",
"state": "DEPLOYED",
"lastlog": 9,
"logs": [{"componentName": null,
"type": "INFO",
"longMessage": "05 Jun 2023 15:06:21 IST : Updating KyvosManager server details."
},
{"componentName": "Agent",
"type": "INFO",
"longMessage": "05 Jun 2023 15:06:21 IST : Updating Agent configuration properties..."
},
{"componentName": "Agent",
"type": "INFO",
"longMessage": "05 Jun 2023 15:06:21 IST [127.0.0.1] : Checking configuration file existence - /home/kyvos/OnPremTemp1/kyvosmanagerdata/agent/conf/agent.properties"
},
{"componentName": "Agent",
"type": "INFO",
"longMessage": "05 Jun 2023 15:06:21 IST [127.0.0.1] : Updating SERVER_IP in file /home/kyvos/OnPremTemp1/kyvosmanagerdata/agent/conf/agent.properties"
},
{"componentName": "Agent",
"type": "INFO",
"longMessage": "05 Jun 2023 15:06:21 IST [127.0.0.1] : Updating ENABLE_CERT_HOST_VERIFICATION in file /home/kyvos/OnPremTemp1/kyvosmanagerdata/agent/conf/agent.properties"
},
{"componentName": "Agent",
"type": "INFO",
"longMessage": "05 Jun 2023 15:06:21 IST [127.0.0.1] : Updating PROTOCOL in file /home/kyvos/OnPremTemp1/kyvosmanagerdata/agent/conf/agent.properties"
},
{"componentName": "Agent",
"type": "INFO",
"longMessage": "05 Jun 2023 15:06:21 IST [127.0.0.1] : Updating PORT in file /home/kyvos/OnPremTemp1/kyvosmanagerdata/agent/conf/agent.properties"
},
{"componentName": "Kyvos",
"type": "INFO",
"longMessage": "05 Jun 2023 15:06:21 IST : Updating Kyvos configuration properties..."
},
{"componentName": null,
"type": "INFO",
"longMessage": "05 Jun 2023 15:06:21 IST : KyvosManager server details update completed."
}
]
},
"STATUS": 200,
"MESSAGE": "The request to get the operation logs has been accepted.",
"ERRORS": null
}

Get Linked Operations Details

This API is used to fetch the details of operations linked to a specific operation ID. In the operation detail call, if any operation has the linked property set as true, it means the operation is linked.

Authorizations:

basicAuth

path Parameters

operationId

required

string

Operation ID for which you want to fetch linked operations.

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

200
401

Content type

application/json

{"OUTPUT": {"chain": [{"opDisplayName": "Upgrade Kyvos Manager",
"operationId": 21,
"errCount": 0,
"warnCount": 0,
"status": "COMPLETED",
"linked": true,
"linkStart": true
},
{"opDisplayName": "Upgrade Kyvos",
"operationId": 22,
"errCount": 0,
"warnCount": 0,
"status": "COMPLETED",
"linked": true,
"linkStart": false
}
]
},
"STATUS": 200,
"MESSAGE": "The request to get the linked operation details has been accepted.",
"ERRORS": null
}

Utilities

Kyvos Manager Utilities REST APIs allow you to perform operations such as synchronizing configuration and synchronizing libraries.

Synchronize Configurations

This API is used to synchronize the configuration libraries and files on each cluster node. It is required when you change the configuration paths, name node/EMR/Dataproc node IP/hostname, or change the version of compute cluster.

The response of the API call shows the Operation ID of the synchronize configurations operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

202
400
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 4
},
"STATUS": 202,
"MESSAGE": "The request to synchronize configuration has been accepted.",
"ERRORS": null
}

Synchronize Libraries

This API is used to synchronize the libraries on each cluster node. It is required when you change the libraries paths, name node/EMR/Dataproc node IP/hostname, or change the version of compute cluster. The response of the API call shows the Operation ID of the synchronize libraries operation. To get a status of operation, use this API Get Single Operation Details or for operation log use this API Get Operation Logs.

Authorizations:

basicAuth

header Parameters

Accept

required

string

Value: "application/JSON"

Example: application/JSON

Supported response type: JSON.

Responses

Response samples

202
400
401

Content type

application/json

{"OUTPUT": {"status": true,
"operationId": 4
},
"STATUS": 202,
"MESSAGE": "The request to synchronize libraries has been accepted.",
"ERRORS": null
}