plan cancel
post
/V0/nosql/admin/plan#cancel
Cancels a plan that is not running. A running plan must be interrupted before it can be canceled.
Use last
to reference the most recently created plan.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Admin CLI Command:
plan cancel -id | -last
plan cancel -id
Root Schema : schema
Type:
Show Source
object
-
arguments: array
arguments
-
command(required): string
Allowed Values:
[ "cancel" ]
Example:
{
"command":"cancel",
"arguments":[
{
"id":"Id of the plan to interrupt"
},
{
"last":"true|false Whether to interrupt the last plan"
}
]
}
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