topology preview
post
/V0/nosql/admin/topology#preview
Describes the actions that would be taken to transition from the starting topology to the named, target topology. If
start
is not specified the current topology is used. This command should be used before deploying a new topology.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:
[ "preview" ]
Example:
{
"command":"preview",
"arguments":[
{
"name":"Name of the topology candidate to preview"
},
{
"start":"Name of the starting topology. Change to the target topology to preview the change. If this value is not specified, current topology is used."
}
]
}
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