admin_startStateMigration

The startStateMigration is an administrative method that starts a state migration and removes old state/storage trie nodes. This can save the storage space of a Klaytn node. The method returns an error if it fails to start a state migration, or null if it succeeds to start. NOTE: After the state migration, the node cannot serve APIs with previous states.

JSONRPC: admin_startStateMigration

Request

application/json

Body

method stringrequired

Default value: admin_startStateMigration

Method name

id int64required

Default value: 1

Request ID, Random or Auto incrementation

jsonrpc stringrequired

Default value: 2.0

JSON-RPC Version (2.0)

params array

Responses

200

null if the state migration has started, or an error message if not.

application/json

Schema

Schema

jsonrpc stringrequired

Default value: 2.0

id int64required

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

| code | message | description | |-----|-----|-------| | -32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. | |-32602 | Invalid params | Invalid method parameter(s). |

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result string

null if the state migration has started, or an error message if not.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": null
}

• curl
• python
• nodejs
• java

• CURL

curl -L -X POST 'http://localhost:8551/admin/startStateMigration' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "method": "admin_startStateMigration",
  "id": 1,
  "jsonrpc": "2.0",
  "params": [
    null
  ]
}'

Request Collapse all

Base URL

http://localhost:8551

Body

{
  "method": "admin_startStateMigration",
  "id": 1,
  "jsonrpc": "2.0",
  "params": [
    null
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!