Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• arguments: array arguments
• command(required): string
  Allowed Values: [ "remove" ]

{
    "required":[
        "command"
    ],
    "properties":{
        "command":{
            "type":"string",
            "enum":[
                "remove"
            ]
        },
        "arguments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "argumentName":{
                        "type":"string"
                    },
                    "argumentValue":{
                        "oneOf":[
                            {
                                "type":"string"
                            },
                            {
                                "type":"boolean"
                            }
                        ]
                    }
                }
            }
        }
    },
    "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"
            }
        ]
    }
}

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"
        }
    ]
}

Nested Schema : arguments

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "argumentName":{
                "type":"string"
            },
            "argumentValue":{
                "oneOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"boolean"
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• argumentName: string
• argumentValue: argumentValue

{
    "type":"object",
    "properties":{
        "argumentName":{
            "type":"string"
        },
        "argumentValue":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"boolean"
                }
            ]
        }
    }
}

Nested Schema : argumentValue

Match One Schema

Show Source

• string
• boolean

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"boolean"
        }
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Operation ended successfully

Body ()

Root Schema : commonResponse

Type: object

Show Source

• description(required): string
• operation(required): string
• returnCode(required): string
• returnValue(required): object returnValue

{
    "properties":{
        "operation":{
            "type":"string"
        },
        "returnCode":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "returnValue":{
            "type":"object"
        }
    },
    "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"
    },
    "required":[
        "operation",
        "returnCode",
        "description",
        "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

Back to Top