change-policy
post
/V0/nosql/admin#change-policy
Modifies store-wide policy parameters to services you have not yet deployed. If you use dryRun,
the command returns the parameters you specify without changing them.
The "params" argument is an array of objects. Each object has only one field of parameter name/value pairs.
For example:{"params":[{"name1":"value1"},{"name1":"value1"},{"name*":"value*"}*]}
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:
[ "change-policy" ]
Example:
{
"command":"change-policy",
"arguments":[
{
"dryRun":"true|false boolean value to specify whether this run will actually execute on server side"
},
{
"params":"Array of objects. Each object has only one field of parameter name/value pairs. For example: {\"params\":[{\"name1\":\"value1\"},{\"name1\":\"value1\"},{\"name*\":\"value*\"}*]}"
}
]
}
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