snapshot remove
post
/V0/nosql/admin/snapshot#remove
Removes the named snapshot. If
all
is set to true, all snapshots are removed. If the zone id or name is specified then the command applies to all the SNs running in that zone. Snapshot of configurations is also removed for related SNs in the zones.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:
[ "remove" ]
Example:
{
"command":"remove",
"arguments":[
{
"name":"Name of the snapshot to remove"
},
{
"all":"true|false boolean value to specify whether to remove all snapshots"
},
{
"zn":"Id of the zone for snapshot operation"
}
]
}
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