show plans
post
/V0/nosql/admin/plans
Shows details of the specified plan or list all plans that have been created along with their corresponding plan IDs and status.
last:
shows details of the most recent planid:
shows details of the plan with the given id. Ifnum
is also given, listnum
plans, starting with plan id specified.num:
sets the number of plans to list. Defaults to 10.from:
lists plans after the date specified.to:
lists plans before the date specified.
Combining from
with to
describes the range between the two dates. Otherwise num
applies.
If none of the above arguments are specified, the ten most recent plans are listed.
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:
[ "show" ]
Example:
{
"command":"show",
"arguments":[
{
"last":"true|false Whether to show the last plan was executed"
},
{
"id":"Id of the plan to show"
},
{
"from":"Start date of plans to show"
},
{
"to":"End date of plans to show"
},
{
"num":"Maximum number of plans"
}
]
}
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