topology remove-shard
post
/V0/nosql/admin/topology#remove-shard
Removes a failed shard from the topology.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
arguments: array
arguments
-
command(required): string
Allowed Values:
[ "remove-shard" ]
Example:
{
"command":"remove-shard",
"arguments":[
{
"hidden":"true - This command requires hidden flag to be true"
},
{
"name":"Name of the topology from which the shard must be removed"
},
{
"failedShard":"shard ID of the shard to be removed in rgX format"
}
]
}
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