モード API¶

モードの詳細についてはモード機能をご確認ください。

ChangeMode¶

バージョン 2021.2.0 で追加。

x-sora-target:: Sora_20211215.ChangeMode

Sora のモードを変更します。

キー	型
mode	string (normal \| block_new_session \| block_new_connection)

mode はすべての新規コネクションを受け入れる normal 、新規セッションの受け入れを停止する block_new_session と新規コネクションの受け入れを停止する block_new_connection が指定できます。

$ curl -sS \
    -X POST \
    http://127.0.0.1:3000/ \
    -H "x-sora-target: Sora_20211215.ChangeMode" \
    --json '{"mode":"block_new_connection"}' \
    | jq .
{
    "mode": "block_new_connection"
}

GetMode¶

バージョン 2021.2.0 で追加。

x-sora-target:: Sora_20211215.GetMode

Sora のモードを取得します。

$ curl -sS \
    -X POST \
    http://127.0.0.1:3000/ \
    -H "x-sora-target: Sora_20211215.GetMode" \
    | jq .
{
    "mode": "normal"
}