ジャンプ先

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

plan deploy-zone

post

/V0/nosql/admin/plan#deploy-zone

指定されたゾーンをストアにデプロイし、typeが指定されていない場合はプライマリ・ゾーンを作成します。

リクエスト

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

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

• application/json

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

管理CLIコマンド:
plan deploy-zone -name -rf [-type {primary | secondary}] [-arbiters | -no-arbiters] [-master-affinity | -no-master-affinity]

ルート・スキーマ: schema

型: object

ソースの表示

• arguments: array arguments
• command(required): string
  指定できる値: [ "deploy-zone" ]

{
    "required":[
        "command"
    ],
    "properties":{
        "command":{
            "type":"string",
            "enum":[
                "deploy-zone"
            ]
        },
        "arguments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "argumentName":{
                        "type":"string"
                    },
                    "argumentValue":{
                        "oneOf":[
                            {
                                "type":"string"
                            },
                            {
                                "type":"boolean"
                            }
                        ]
                    }
                }
            }
        }
    },
    "example":{
        "command":"deploy-zone",
        "arguments":[
            {
                "name":"Name of the zone"
            },
            {
                "rf":"Replication factor of the zone"
            },
            {
                "type":"primary|secondary type of zone to deploy"
            },
            {
                "arbiters":"true|false Whether this zone enable arbiters"
            },
            {
                "masterAffinity":"true|false Whether this zone enable master affinity"
            }
        ]
    }
}

例:

{
    "command":"deploy-zone",
    "arguments":[
        {
            "name":"Name of the zone"
        },
        {
            "rf":"Replication factor of the zone"
        },
        {
            "type":"primary|secondary type of zone to deploy"
        },
        {
            "arbiters":"true|false Whether this zone enable arbiters"
        },
        {
            "masterAffinity":"true|false Whether this zone enable master affinity"
        }
    ]
}

ネストされたスキーマ: 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

先頭に戻る