plan register-es
post
/V0/nosql/admin/plan#register-es
Registers an Elasticsearch cluster with the store. It is only necessary to register one node of the cluster, as the other nodes in the cluster will be found automatically.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Admin CLI Command:
plan register-es -clustername -host -port
plan register-es -clustername
Root Schema : schema
Type:
Show Source
object
-
arguments: array
arguments
-
command(required): string
Allowed Values:
[ "register-es" ]
Example:
{
"command":"register-es",
"arguments":[
{
"clustername":"Elasticsearch cluster name"
},
{
"host":"Host name for Elasticsearch"
},
{
"port":"Port number for Elasticsearch"
}
]
}
Response
Supported Media Types
- application/json
200 Response
Operation ended successfully
Root Schema : commonResponse
Type:
Show Source
object
-
description(required): string
-
operation(required): string
-
returnCode(required): string
-
returnValue(required): object
returnValue
Example:
{
"operation":"operation executed",
"returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
"description":"error description when returnCode != 5000",
"returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
}
Nested Schema : returnValue
Type:
object