Previous Next JavaScript must be enabled to correctly display this content

## 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

Request Body - application/json ()
Root Schema : schema
Type: `object`
Show Source

- arguments(required): array arguments
- command(required): string
  Allowed Values: `[ "show" ]`

    {
        "required":[
            "command",
            "arguments"
        ],
        "properties":{
            "command":{
                "type":"string",
                "enum":[
                    "show"
                ]
            },
            "arguments":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "argumentName":{
                            "type":"string"
                        },
                        "argumentValue":{
                            "oneOf":[
                                {
                                    "type":"string"
                                },
                                {
                                    "type":"boolean"
                                }
                            ]
                        }
                    }
                }
            }
        },
        "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"
                }
            ]
        }
    }

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"
            }
        ]
    }

Nested Schema : arguments
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object",
            "properties":{
                "argumentName":{
                    "type":"string"
                },
                "argumentValue":{
                    "oneOf":[
                        {
                            "type":"string"
                        },
                        {
                            "type":"boolean"
                        }
                    ]
                }
            }
        }
    }

Nested Schema : items
Type: `object`
Show Source

- argumentName: string
- argumentValue: argumentValue

    {
        "type":"object",
        "properties":{
            "argumentName":{
                "type":"string"
            },
            "argumentValue":{
                "oneOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"boolean"
                    }
                ]
            }
        }
    }

Nested Schema : argumentValue
Match One Schema
Show Source

- string
- boolean

    {
        "oneOf":[
            {
                "type":"string"
            },
            {
                "type":"boolean"
            }
        ]
    }

Back to Top

### Response

Supported Media Types

- application/json

#### 200 Response

Operation ended successfully
Body ()
Root Schema : commonResponse
Type: `object`
Show Source

- description(required): string
- operation(required): string
- returnCode(required): string
- returnValue(required): object returnValue

    {
        "properties":{
            "operation":{
                "type":"string"
            },
            "returnCode":{
                "type":"string"
            },
            "description":{
                "type":"string"
            },
            "returnValue":{
                "type":"object"
            }
        },
        "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"
        },
        "required":[
            "operation",
            "returnCode",
            "description",
            "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`
Back to Top