plan remove-admin
/V0/nosql/admin/plan#remove-admin
Removes the desired Admin instances; either the single specified instance, or all instances deployed to the specified zone.
If the admin
flag is used and there are 3 or fewer Admins running in the store, or if the zn
or znname
flag is used and the removal of all Admins from the specified zone would result in only one or two Admins in the store, then the desired Admins will be removed only if the force
flag is also specified.
Additionally, if the admin
flag is used and there is only one Admin in the store, or if the zn
or znname
flag is used and the removal of all Admins from the specified zone would result in the removal of all Admins from the store, then the desired Admins will not be removed.
Request
There are no request parameters for this operation.
- application/json
plan remove-admin -admin
object
-
arguments: array
arguments
-
command(required): string
Allowed Values:
[ "remove-admin" ]
{
"command":"remove-admin",
"arguments":[
{
"admin":"Id of the admin to remove"
},
{
"zn":"Remove the admin in the zone by Id"
},
{
"znname":"Remove the admin in the zone by name"
},
{
"failedSn":"true|false Whether the admin is on a failed SN"
}
]
}
Response
- application/json
200 Response
object
-
description(required): string
-
operation(required): string
-
returnCode(required): string
-
returnValue(required): object
returnValue
{
"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"
}
object