XRP Ledger Apex is back in Amsterdam

Register Now
Last updated
Edit

node_to_shard

[ソース]

node_to_shardメソッドは、レジャーストアからシャードストアへのデータコピーを管理します。データコピーの開始、停止、状態チェックが可能です。

node_to_shardメソッドは、権限のないユーザには実行できない管理メソッドです。

リクエストのフォーマット

リクエストのフォーマット例:

  1. WebSocket
  2. JSON-RPC
  3. Commandline
{
    "command": "node_to_shard",
    "action": "start"
}

リクエストは、以下のパラメータを含みます:

項目説明
actionStringどのような動作をさせるかによって、 startstop または status のいずれかを指定します。

レスポンスのフォーマット

正常レスポンス例:

  1. WebSocket
  2. JSON-RPC
  3. Commandline
{
  "result": {
    "message": "Database import initiated..."
  },
  "status": "success",
  "type": "response"
}

レスポンスは、標準フォーマットに従っており、成功した場合は、以下の項目を含みます:

項目説明
message文字列コマンドにレスポンスして実行されたアクションを示す、可読性の高いメッセージ。

起こり得るエラー

  • いずれかの汎用エラータイプ
  • internal - コピーが実行されていない時にコピーの状態チェックをするといったような無効な操作の場合。
  • notEnabled - サーバが履歴シャードを保存するように環境設定されていない場合。
  • invalidParams - 1つ以上の項目が誤って定義されている、もしくは、1つ以上の必須項目が抜けている。