show topology
post
/V0/nosql/admin/topology#show
Displays the current, deployed topology. By default, it shows the entire topology. The optional flags restrict the display to one or more Zones, RepNodes, StorageNodes and Storename, or to specify service status.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Admin CLI Command:
show topology [-zn] [-rn] [-an] [-sn] [-store] [-status] [-perf]
show topology [-zn] [-rn] [-an] [-sn] [-store] [-status] [-perf]
Root Schema : schema
Type:
Show Source
object
-
arguments(required): array
arguments
-
command(required): string
Allowed Values:
[ "show" ]
Example:
{
"command":"show",
"arguments":[
{
"zn":"true|false Whether to show zone information"
},
{
"rn":"true|false Whether to show RN information"
},
{
"an":"true|false Whether to show AN information"
},
{
"sn":"true|false Whether to show SN information"
},
{
"store":"true|false Whether to show store information"
}
]
}
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