メインコンテンツまでスキップ
に最終更新

ロードキャンセルアクション

リクエスト​

POST /api/<db>/_cancel

説明​

指定したラベルのロードトランザクションをキャンセルします。 戻り値 JSON 形式の文字列を返します。 ステータス: 成功: キャンセル成功 その他: キャンセル失敗 メッセージ: キャンセルに失敗した場合のエラーメッセージ

パスパラメータ​

  • <db>

    データベース名を指定します。

クエリパラメータ​

  • <label>

    ロードラベルを指定します。

リクエストボディ​

なし

レスポンス​

  • キャンセル成功

    {
    "msg": "OK",
    "code": 0,
    "data": null,
    "count": 0
    }
  • キャンセル失敗

    {
    "msg": "Error msg...",
    "code": 1,
    "data": null,
    "count": 0
    }

例​

  1. 指定したラベルのロードトランザクションをキャンセルする

    POST /api/example_db/_cancel?label=my_label1

    Response:
    {
    "msg": "OK",
    "code": 0,
    "data": null,
    "count": 0
    }