Jump to

• Request
• Response

show parameters

post

/V0/nosql/admin/parameters

Displays service parameters and state for the specified service. The service may be a RepNode, StorageNode, or Admin service, as identified by any valid string, for example rg1-rn1, sn1, admin2, etc. Use the policy flag to show global policy default parameters. Use the security flag to show global security parameters. Use the global flag to show global component parameters.

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: array arguments
• command(required): string
  Allowed Values: [ "show" ]

{
    "required":[
        "command"
    ],
    "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":[
            {
                "policy":"true|false Whether to show policy related parameters"
            },
            {
                "global":"true|false Whether to show global parameters"
            },
            {
                "security":"true|false Whether to show security parameters"
            },
            {
                "service":"Name of the service to show the parameters"
            }
        ]
    }
}

Example:

{
    "command":"show",
    "arguments":[
        {
            "policy":"true|false Whether to show policy related parameters"
        },
        {
            "global":"true|false Whether to show global parameters"
        },
        {
            "security":"true|false Whether to show security parameters"
        },
        {
            "service":"Name of the service to show the parameters"
        }
    ]
}

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