ジャンプ先

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

plan stop-service

post

/V0/nosql/admin/plan#stop-service

指定されたサービスを停止します。

リクエスト

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

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

• application/json

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

管理CLIコマンド:
plan stop-service {-service | -all-rns [-zn | -znname ] | -all-ans [-zn | -znname ] | -zn | -znname }

ルート・スキーマ: schema

型: object

ソースの表示

• arguments(optional): array arguments
• command: string
  指定できる値: [ "stop-service" ]

{
    "required":[
        "command"
    ],
    "properties":{
        "command":{
            "type":"string",
            "enum":[
                "stop-service"
            ]
        },
        "arguments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "argumentName":{
                        "type":"string"
                    },
                    "argumentValue":{
                        "oneOf":[
                            {
                                "type":"string"
                            },
                            {
                                "type":"boolean"
                            }
                        ]
                    }
                }
            }
        }
    },
    "example":{
        "command":"stop-service",
        "arguments":[
            {
                "service":"Id of the service to stop"
            },
            {
                "allRns":"true|false Whether to stop all RNs"
            },
            {
                "zn":"Id of the zone to stop services"
            },
            {
                "znname":"Name of the zone to stop services"
            }
        ]
    }
}

例:

{
    "command":"stop-service",
    "arguments":[
        {
            "service":"Id of the service to stop"
        },
        {
            "allRns":"true|false Whether to stop all RNs"
        },
        {
            "zn":"Id of the zone to stop services"
        },
        {
            "znname":"Name of the zone to stop services"
        }
    ]
}

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

型: array

ソースの表示

• 配列: object items

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

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

型: object

ソースの表示

• argumentName(optional): string
• argumentValue(optional): 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: string
• operation: string
• returnCode: string
• returnValue: object returnValue

{
    "properties":{
        "operation":{
            "type":"string"
        },
        "returnCode":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "returnValue":{
            "type":"object"
        }
    },
    "example":{
        "operation":"Command related operation",
        "returnCode":"Error code to indicate the command result, 5000 infers plan success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem of executing plan.",
        "description":"Textual output of the command",
        "returnValue":"Valuable information returned by the command execution in JSON object format"
    },
    "required":[
        "operation",
        "returnCode",
        "description",
        "returnValue"
    ]
}

例:

{
    "operation":"Command related operation",
    "returnCode":"Error code to indicate the command result, 5000 infers plan success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem of executing plan.",
    "description":"Textual output of the command",
    "returnValue":"Valuable information returned by the command execution in JSON object format"
}

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

型: object

先頭に戻る