topology validate
post
/V0/nosql/admin/topology#validate
Validates the specified topology. If no name
is provided, the current topology is validated. Validation generates violations and notes.
Violations are issues that can cause problems and should be investigated. Notes are informational and highlight configuration oddities that could be potential issues or may be expected.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
arguments(required): array
arguments
-
command(required): string
Allowed Values:
[ "validate" ]
Example:
{
"command":"validate",
"arguments":[
{
"name":"Name of the topology to validate"
}
]
}
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