plan stop-service
post
/V0/nosql/admin/plan#stop-service
Stops the specified service(s).
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Admin CLI Command:
plan stop-service {-service | -all-rns [-zn | -znname ] | -all-ans [-zn | -znname ] | -zn | -znname }
plan stop-service {-service
Root Schema : schema
Type:
Show Source
object
-
arguments: array
arguments
-
command(required): string
Allowed Values:
[ "stop-service" ]
Example:
{
"command":"stop-service",
"arguments":[
{
"service":"Id of the service to stop"
},
{
"allRns":"true|false Whether to stop all RNs"
},
{
"zn":"Id of the zone to stop services"
},
{
"znname":"Name of the zone to stop services"
}
]
}
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