ジャンプ先

• リクエスト
• レスポンス

plan remove-admin

post

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

必要な管理インスタンス(単一の指定されたインスタンスまたはデプロイされたすべてのインスタンス)を指定されたゾーンに移動します。

adminフラグを使用しており、ストア内で実行されているAdminが3つ以下である場合、あるいはznまたはznnameフラグを使用しており、指定したゾーンからすべてのAdminを削除するとストア内に残るAdminが1つか2つのみになる場合は、forceフラグも指定した場合のみ、目的のAdminが削除されます。

また、adminフラグを使用しており、ストア内のAdminが1つのみである場合、あるいはznまたはznnameフラグを使用しており、指定したゾーンからすべてのAdminを削除するとストアからすべてのAdminが削除されることになる場合、目的のAdminは削除されません。

リクエスト

この操作のリクエスト・パラメータはありません。

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

ソースの表示

• arguments: array arguments
• command(required): string
  指定できる値: [ "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"
            }
        ]
    }
}

例:

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

ネストされたスキーマ: argument

型: array

ソースの表示

• 配列: object items

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

ネストされたスキーマ: items

型: object

ソースの表示

• argumentName: string
• argumentValue: argumentValue

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

ネストされたスキーマ : argumentValue

1つのスキーマに一致

ソースの表示

• string
• boolean

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

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200 Response

Operation ended successfully

本文()

ルート・スキーマ: commonResponse

型: object

ソースの表示

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

例:

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

ネストされたスキーマ: returnValue

型: object

先頭に戻る