topology preview
post
/V0/nosql/admin/topology#preview
起動トポロジから指定されたターゲット・トポロジに移行するために実行される操作について説明します。
start
が指定されていない場合は、現行トポロジを使用します。このコマンドは、新規トポロジをデプロイする前に使用する必要があります。リクエスト
この操作のリクエスト・パラメータはありません。
サポートされているメディア・タイプ
- application/json
管理CLIコマンド:
topology preview -name [-start ]
topology preview -name
ルート・スキーマ: schema
型:
ソースの表示
object
- arguments(optional): array arguments
- command: string
指定できる値:
[ "preview" ]
例:
{
"command":"preview",
"arguments":[
{
"name":"Name of the topology candidate to preview"
},
{
"start":"Name of the starting topology. Change to the target topology to preview the change. If this value is not specified, current topology is used."
}
]
}
レスポンス
サポートされているメディア・タイプ
- application/json
200 Response
Operation ended successfully
ルート・スキーマ: commonResponse
型:
ソースの表示
object
例:
{
"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