ジャンプ先

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

show plans

post

/V0/nosql/admin/plans

指定されたプランの詳細を表示するか、対応するプランIDおよびステータスとともに作成されているすべてのプランを一覧表示します。

• last: 最新のプランの詳細を示します。
• id: 指定されたIDを持つプランの詳細を示します。numも指定されている場合は、指定されたプランIDから始まるnum個のプランをリストします。
• num: リストするプランの数を設定します。デフォルトは10です。
• from: 指定された日付より後のプランをリストします。
• to: 指定された日付より前のプランをリストします。

fromとtoを組み合せて使用することで、2つの日付の間の期間を指定できます。それ以外の場合、numが適用されます。

前述の引数が1つも指定されていない場合は、最新の10個のプランをリストします。

リクエスト

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

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

• application/json

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

管理CLIコマンド:
show plans [-last] [-id ] [-from ] [-to ] [-num ]

ルート・スキーマ: schema

型: object

ソースの表示

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

{
    "required":[
        "command",
        "arguments"
    ],
    "properties":{
        "command":{
            "type":"string",
            "enum":[
                "show"
            ]
        },
        "arguments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "argumentName":{
                        "type":"string"
                    },
                    "argumentValue":{
                        "oneOf":[
                            {
                                "type":"string"
                            },
                            {
                                "type":"boolean"
                            }
                        ]
                    }
                }
            }
        }
    },
    "example":{
        "command":"show",
        "arguments":[
            {
                "last":"true|false Whether to show the last plan was executed"
            },
            {
                "id":"Id of the plan to show"
            },
            {
                "from":"Start date of plans to show"
            },
            {
                "to":"End date of plans to show"
            },
            {
                "num":"Maximum number of plans"
            }
        ]
    }
}

例:

{
    "command":"show",
    "arguments":[
        {
            "last":"true|false Whether to show the last plan was executed"
        },
        {
            "id":"Id of the plan to show"
        },
        {
            "from":"Start date of plans to show"
        },
        {
            "to":"End date of plans to show"
        },
        {
            "num":"Maximum number of plans"
        }
    ]
}

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

先頭に戻る