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
Admin CLI Command:
show parameters -policy | -global | -security | -service
show parameters -policy | -global | -security | -service
Root Schema : schema
Type:
Show Source
object
-
arguments: array
arguments
-
command(required): string
Allowed Values:
[ "show" ]
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"
}
]
}
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