Jump to

• Request
• Response

plan remove-admin

post

/V0/nosql/admin/plan#remove-admin

Removes the desired Admin instances; either the single specified instance, or all instances deployed to the specified zone.

If the admin flag is used and there are 3 or fewer Admins running in the store, or if the zn or znname flag is used and the removal of all Admins from the specified zone would result in only one or two Admins in the store, then the desired Admins will be removed only if the force flag is also specified.

Additionally, if the admin flag is used and there is only one Admin in the store, or if the zn or znname flag is used and the removal of all Admins from the specified zone would result in the removal of all Admins from the store, then the desired Admins will not be removed.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Admin CLI Command:
plan remove-admin -admin | -zn | -znname [-failedSn]

Root Schema : schema

Type: object

Show Source

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

{
    "required":[
        "command"
    ],
    "properties":{
        "command":{
            "type":"string",
            "enum":[
                "remove-admin"
            ]
        },
        "arguments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "argumentName":{
                        "type":"string"
                    },
                    "argumentValue":{
                        "oneOf":[
                            {
                                "type":"string"
                            },
                            {
                                "type":"boolean"
                            }
                        ]
                    }
                }
            }
        }
    },
    "example":{
        "command":"remove-admin",
        "arguments":[
            {
                "admin":"Id of the admin to remove"
            },
            {
                "zn":"Remove the admin in the zone by Id"
            },
            {
                "znname":"Remove the admin in the zone by name"
            },
            {
                "failedSn":"true|false Whether the admin is on a failed SN"
            }
        ]
    }
}

Example:

{
    "command":"remove-admin",
    "arguments":[
        {
            "admin":"Id of the admin to remove"
        },
        {
            "zn":"Remove the admin in the zone by Id"
        },
        {
            "znname":"Remove the admin in the zone by name"
        },
        {
            "failedSn":"true|false Whether the admin is on a failed SN"
        }
    ]
}

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