Perform various action on app instance.

post

https://cluster.ip.address/irisservices/api/v1/public/appInstances/{appInstanceId}/actions

For performing various actions on the installed app instance. Fetch appInstanceId using GET /public/appInstances API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

appInstanceId

int64

required

Specifies the app instance Id.

Body Params

Specifies the current Cluster-level operation in progress.

Specifies the parameters for performing various action on NoSQL app
instance.

action

string | null

enum

Specifies the current Cluster-level operation in progress.
'kRefreshConfig' Refreshes xml configs for site files for NoSql App from Gandalf.
'kListConfig' List xml Configs set in site files using GFlag approach.
'kRestartServices' restart App services. e.g yarn, zookeeper etc.
'kSSLImport' Import ssl certificates to App's TrustStore/Keystore.
'kSSLListCertificates' List ssl certificates from Keystore/TrustStore.
'kSSLDeleteCertificate' Delete specific certificates from TrustStore.
'kSSLDeleteStore' Delete trustore/keystore from App.
'kKerberosAddrealm' Add kerberos realm.
'kKerberosDeleteRealm' Delete kerberos realm.
'kKerberosImportKeyTab' Import keytab.

listConfigParams

object | null

Specifies a list of configs types to list configs for.

restartServicesParams

object | null

Specifies a list of services to restart. These will be restarted.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Response of performing various action on app instance. Specifies the results on performing various action on app instance.

defaultError