admin

Klaytn 노드를 제어하는 API입니다.

admin namespace는 몇몇 비표준 RPC 메서드에 접근할 수 있게 합니다. 이를 통해 네트워크 피어와 RPC 엔드포인트 관리 등 Klaytn 인스턴스를 세밀하게 제어할 수 있습니다.

admin_nodeInfo

nodeInfo 관리 속성을 조회하여 실행 중인 Klaytn 노드에 대해 알려진 모든 정보를 네트워크 수준에서 확인할 수 있습니다. devp2p P2P 오버레이 프로토콜에 참여하는 노드 자체의 일반적인 정보 및 klay와 같은 실행 중인 애플리케이션 프로토콜에 의해 추가된 세부적인 정보 또한 확인할 수 있습니다.

클라이언트 메서드 호출

클라이언트	메서드 호출
콘솔	`admin.nodeInfo`
RPC	`{"method": "admin_nodeInfo"}`

콘솔

admin.nodeInfo

RPC

{"method": "admin_nodeInfo"}

파라미터

없음

리턴값

타입	Description
JSON 문자열	노드에 대한 정보입니다.

타입

Description

JSON 문자열

노드에 대한 정보입니다.

예시

Console

> admin.nodeInfo
{
   kni: "kni://0bbff960d26fc12a5153ac25d7aaffd654e073a74a8b1aa65034250d47fac610ebe99a83d21d741c6121a32fb01312b49fc0633ae04e80c5eb73c3bc71c5a850@[::]:32323?discport=0",
   id: "0bbff960d26fc12a5153ac25d7aaffd654e073a74a8b1aa65034250d47fac610ebe99a83d21d741c6121a32fb01312b49fc0633ae04e80c5eb73c3bc71c5a850",
   ip: "::",
   listenAddr: "[::]:32323",
   name: "Klaytn/validator-1/vX.X.X/XXXX-XXXX/goX.X.X",
   ports: {
     discovery: 0,
     listener: 32323
   },
   protocols: {
     istanbul: {
       config: {
         chainId: 2018,
         isBFT: true,
         istanbul: {...},
         unitPrice: 0
       },
       difficulty: 52794,
       genesis: "0x42824367c973785245923a712cf2e5a99aae6a26f44e4f1ec686a0e60986644e",
       head: "0x4c3000a6f8c40b0507d8ee4a3fc5c9865df0a8d66f882366ea95473c87342005",
       network: 2017
     }
   }
}

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_nodeInfo","id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,
"result":               {"id":"377ef808aff73a397d133b3bf160df586054c98c0e6a65c8fce9560e6a0632bc975419f461803d27f28ee270287113cc2359225814debc1bfb2f811061e14c5d", "name":"Klaytn/vvX.X.X/XXXX-XXXX/goX.X.X",    "kni":"kni://377ef808aff73a397d133b3bf160df586054c98c0e6a65c8fce9560e6a0632bc975419f461803d27f28ee270287113cc2359225814debc1bfb2f811061e14c5d@[::]:32323?discport=0",
"ip":"::",
"ports":{"discovery":0,"listener":32323},
"listenAddr":"[::]:32323",
"protocols":{"istanbul":{"network":1000,"difficulty":1,"genesis":"0x06806bd8b1e086dfb7098a289da07037a3af58e793d205d20f61c88eeea9351d","config":{"chainId":1000,"istanbul":{"epoch":30000,"policy":0,"sub":7},"isBFT":true,"unitPrice":25000000000,"deriveShaImpl":0},"head":"0x06806bd8b1e086dfb7098a289da07037a3af58e793d205d20f61c88eeea9351d"}}}}

admin_datadir

datadir 관리 속성을 조회하여 실행 중인 Klaytn 노드가 현재 모든 데이터베이스를 저장하는 데에 사용하는 절대 경로를 확인할 수 있습니다. 기본으로 설정된 경로는 노드 타입(kcn, kpn, ken)과 운영체제에 따라 다릅니다.

Client Method invocation

Client	Method invocation
Console	`admin.datadir`
RPC	`{"method": "admin_datadir"}`

Console

admin.datadir

RPC

{"method": "admin_datadir"}

Parameters

None

Return Value

Type Description

Type	Description
string	`datadir`의 경로입니다.

string

datadir의 경로입니다.

Example

Console

> admin.datadir
"/home/user/Library/KEN"

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_datadir","id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":"/your/dir/ken/data/dd"}

admin_peers

peers 관리 속성은 연결된 원격 노드에 대해 알려진 모든 정보를 네트워크 수준에서 조회할 수 있습니다. devp2p P2P 오버레이 프로토콜에 참여하는 노드 자체의 일반적인 정보 및 개별 실행 중인 애플리케이션 프로토콜에 의해 추가된 세부적인 정보 또한 확인할 수 있습니다.

Client Method invocation

Client	Method invocation
Console	`admin.peers`
RPC	`{"method": "admin_peers"}`

Console

admin.peers

RPC

{"method": "admin_peers"}

Parameters

None

Return Value

Type	Description
JSON string	연결된 모든 피어에 대한 정보입니다.

Type

Description

JSON string

연결된 모든 피어에 대한 정보입니다.

Example

Console

> admin.peers
[{
    caps: ["istanbul/64"],
    id: "5d73afadf1eb4d6ccd1e10ab0f00301a1642b102fb521f170f4eaa4b3cb9a58788d1e2b387d6ce3726cb4786d034feb7dd17b5055b6d9a888520011e5756c89e",
    name: "Klaytn/validator-3/vX.X.X/XXXX-XXXX/goX.X.X",
    network: {
      inbound: true,
      localAddress: "127.0.0.1:32323",
      nodeType: "cn",
      remoteAddress: "127.0.0.1:63323",
      static: false,
      trusted: false
    },
    protocols: {
      istanbul: {
        difficulty: 52794,
        head: "0x4c3000a6f8c40b0507d8ee4a3fc5c9865df0a8d66f882366ea95473c87342005",
        version: 64
      }
    }
},  /* ... */ {
    caps: ["istanbul/64"],
    id: "8bcf4297aa6bb46121bb20a18b7af8f1eaad7e7435c71cb64109511a73c5507744bca138ee76b52d06cecedde9d88fdfddbffc5c3b80c5cbace3c326d5df5f1f",
    name: "Klaytn/validator-2/vX.X.X/XXXX-XXXX/goX.X.X",
    networks: [{
      inbound: true,
      localAddress: "127.0.0.1:32323",
      nodeType: "cn",
      remoteAddress: "127.0.0.1:63247",
      static: false,
      trusted: false
    }],
    protocols: {
      istanbul: {
        difficulty: 52794,
        head: "0x4c3000a6f8c40b0507d8ee4a3fc5c9865df0a8d66f882366ea95473c87342005",
        version: 64
      }
    }
}]

HTTP RPC

참고: 아래 IP 주소는 예시입니다. 실행 환경에서의 실제 IP 주소로 바꿔주세요.

curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_peers","id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":[{"id":"144af69d2bb030c6a2a5ceee7445dc613e200f19358547cffc353d56e6c8a5b4186a6953c028b6afd0ab3c2bfc4c86f24b0bf855d0686b964ec65cefd3deec37","name":"Klaytn/vvX.X.X/XXXX-XXXX/goX.X.X","caps":["istanbul/64"],"network":{"localAddress":"10.0.10.1:49355","remoteAddress":"10.0.0.1:32323","inbound":false,"trusted":false,"static":true},"protocols":{"istanbul":{"version":64,"difficulty":1285901,"head":"0x2d04ac52df4af08a9a0e15d5939c29decb00031e7b3f6abd05bc0c731f6b5561"}}},{"id":"a875620f67f0b12edb97d0ec269e7940f2505b1f62576f39858c37e1d7f956318c3a619239f03f806a79ccaa8e7e9b5def343c24a9fd2e9d715964e0952dd995","name":"Klaytn/vvX.X.X/XXXX-XXXX/goX.X.X","caps":["istanbul/64"],"networks":[{"localAddress":"10.0.10.2:49353","remoteAddress":"10.0.0.2:32323","inbound":false,"trusted":false,"static":true}],"protocols":{"istanbul":{"version":64,"difficulty":1285901,"head":"0x2d04ac52df4af08a9a0e15d5939c29decb00031e7b3f6abd05bc0c731f6b5561"}}},{"id":"e18d6d4e0ffac0a51028a8d49a548295ac8ac50d064f3581600799a3ae761a61f0b39c38b4195e163e01f30db616debf61b5b2ddea716bc8fb1c907ce7a1de26","name":"Klaytn/vvX.X.X/XXXX-XXXX/goX.X.X","caps":["istanbul/64"],"network":{"localAddress":"10.0.10.3:49354","remoteAddress":"10.0.0.3:32323","inbound":false,"trusted":false,"static":true},"protocols":{"istanbul":{"version":64,"difficulty":1285900,"head":"0x2e228a45c7c9b9e6729b6c66b31957d6cb62ce53e32cedf156615a4e8a2e253a"}}}]}

admin_addPeer

addPeer는 추적된 정적 노드들의 목록에 새로운 원격 노드를 추가하도록 요청하는 관리 메서드입니다. 각 노드는 목록의 노드들과의 연결을 항상 유지하고자 하고, 원격 연결이 간혹 끊어지면 다시 연결합니다.

이 메서드는 한 매개변수 kni(Klaytn Network Identifier)만을 입력으로 받습니다. 이는 geth의 enode 개념과 유사합니다. 추적할 원격 피어의 URL이며, 해당 피어의 추적이 허용되었는지 또는 어떤 오류가 발생했는지에 따라 BOOL을 반환합니다.

Client Method invocation

Client	Method invocation
Console	`admin.addPeer(url)`
RPC	`{"method": "admin_addPeer", "params": [url]}`

Console

admin.addPeer(url)

RPC

{"method": "admin_addPeer", "params": [url]}

Parameters

이름 Type Description

이름	Type	Description
url	string	피어의 `kni` URL입니다.

url

string

피어의 kni URL입니다.

Return Value

Type	Description
bool	피어 추적이 허용되면 `true`를 반환하고, 그렇지 않으면 `false`를 반환합니다.

Example

Console

> admin.addPeer("kni://a979fb575495b8d6db44f750317d0f4622bf4c2aa3365d6af7c284339968eef29b69ad0dce72a4d8db5ebb4968de0e3bec910127f134779fbcb0cb6d3331163c@10.0.0.1:32323") //This is an example address.
true

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_addPeer","params":["kni://a979fb575495b8d6db44f750317d0f4622bf4c2aa3365d6af7c284339968eef29b69ad0dce72a4d8db5ebb4968de0e3bec910127f134779fbcb0cb6d3331163c@10.0.0.1:32323"],"id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":true}

admin_removePeer

removePeer는 추적된 정적 노드들의 목록에서 한 노드를 제거하도록 요청하는 관리 메서드입니다.

The method accepts a single argument kni, which means "Klaytn Network Identifier". It is similar to the enode concept in the geth. 목록에서 제거될 원격 피어의 URL이며, 피어가 성공적으로 제거되었거나 어떤 에러가 발생했는지 알려주기 위해 BOOL을 반환합니다.

Client Method invocation

Client	Method invocation
Console	`admin.removePeer(url)`
RPC	`{"method": "admin_removePeer", "params": [url]}`

Console

admin.removePeer(url)

RPC

{"method": "admin_removePeer", "params": [url]}

Parameters

Name Type Description

Name	Type	Description
url	string	Peer's `kni` URL.

url

string

Peer's kni URL.

Return Value

Type	Description
bool	`true` if the peer was accepted, `false` otherwise.

Example

Console

> admin.removePeer("kni://a979fb575495b8d6db44f750317d0f4622bf4c2aa3365d6af7c284339968eef29b69ad0dce72a4d8db5ebb4968de0e3bec910127f134779fbcb0cb6d3331163c@10.0.0.1:32323") //This is an example address.
true

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_removePeer","params":["kni://a979fb575495b8d6db44f750317d0f4622bf4c2aa3365d6af7c284339968eef29b69ad0dce72a4d8db5ebb4968de0e3bec910127f134779fbcb0cb6d3331163c@10.0.0.1:32323"],"id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":true}

admin_startHTTP

참고: 이 API는 admin_startRPC를 대체합니다. admin_startRPC는 곧 사용이 중지됩니다.

startRPC는 HTTP 기반의 JSON RPC API 웹서버를 시작하여 클라이언트 요청을 처리하도록 하는 관리 메서드입니다.

이 메서드는 HTTP RPC 리스너가 열려있는지 여부를 나타내는 불리언 플래그를 반환합니다. 동시에 하나의 HTTP 엔드포인트만이 활성화될 수 있음을 참고해주세요.

Client Method invocation

Client	Method invocation
Console	`admin.startHTTP(host, port, cors, apis)`
RPC	`{"method": "admin_startHTTP", "params": [host, port, cors, apis]}`

Console

admin.startHTTP(host, port, cors, apis)

RPC

{"method": "admin_startHTTP", "params": [host, port, cors, apis]}

Parameters

Name Type Description

Name	Type	Description
host	string	(선택 사항) 리스너 소켓이 열려있는 네트워크 인터페이스입니다. (기본 설정: `"localhost"`)
port	int	(선택 사항) 리스너 소켓이 열려있는 네트워크 포트입니다. (기본 설정: `8551`)
cors	string	(선택 사항) 사용할 cross-origin resource sharing 헤더입니다. (기본 설정: `""`)
apis	string	(선택 사항) 이 인터페이스를 통해 제공할 API 모듈입니다. (기본 설정: `"klay,net,rpc"`)

host

string

(선택 사항) 리스너 소켓이 열려있는 네트워크 인터페이스입니다. (기본 설정: "localhost")

port

int

(선택 사항) 리스너 소켓이 열려있는 네트워크 포트입니다. (기본 설정: 8551)

cors

string

(선택 사항) 사용할 cross-origin resource sharing 헤더입니다. (기본 설정: "")

apis

string

(선택 사항) 이 인터페이스를 통해 제공할 API 모듈입니다. (기본 설정: "klay,net,rpc")

Return Value

Type	Description
bool	HTTP RPC 리스너가 열리면 `true`를 반환하고, 그렇지 않으면 `false`를 반환합니다.

Example

Console

> admin.startHTTP("127.0.0.1", 8551)
true

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_startHTTP","id":1, "params":["127.0.0.1", 8551, "", "klay"]}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"error":{"code":-32000,"message":"HTTP RPC already running on 127.0.0.1:8551"}}

admin_stopHTTP

참고: 이 API는 admin_stopRPC를 대체합니다. admin_stopRPC는 곧 사용이 중지됩니다.

stopRPC는 현재 열려있는 HTTP RPC 엔드포인트를 닫는 관리 메서드입니다. 노드는 하나의 HTTP 엔드포인트를 실행할 수 있기 때문에 이 메서드에 매개변수는 필요하지 않으며, 엔드포인트가 닫혔는지 여부에 따라 불리언으로 결과를 반환합니다.

Client Method invocation

Client	Method invocation
Console	`admin.stopHTTP()`
RPC	`{"method": "admin_stopHTTP"}`

Console

admin.stopHTTP()

RPC

{"method": "admin_stopHTTP"}

Parameters

None

Return Value

Type	Description
bool	엔드포인트가 닫히면 `true`를 반환하고, 그렇지 않으면 `false`를 반환합니다.

Example

Console

> admin.stopHTTP()
true

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_stopHTTP","id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":true}

admin_startWS

startWS는 웹소켓 기반의 JSON RPC API 웹서버를 시작하여 클라이언트 요청을 처리하도록 하는 관리 메서드입니다.

이 메서드는 웹소켓 RPC 리스너가 열려있는지 여부를 나타내는 불리언 플래그를 반환합니다. 동시에 하나의 웹소켓 엔드포인트만이 활성화될 수 있음을 참고해주세요.

Client Method invocation

Client	Method invocation
Console	`admin.startWS(host, port, cors, apis)`
RPC	`{"method": "admin_startWS", "params": [host, port, cors, apis]}`

Console

admin.startWS(host, port, cors, apis)

RPC

{"method": "admin_startWS", "params": [host, port, cors, apis]}

Parameters

Name Type Description

Name	Type	Description
host	string	(optional) network interface to open the listener socket on (default: `"localhost"`).
port	int	(선택 사항) 리스너 소켓을 열기 위한 네트워크 포트입니다. (기본 설정: `8552`)
cors	string	(optional) cross-origin resource sharing header to use (default: `""`).
apis	string	(선택 사항) 이 인터페이스를 통해 제공할 API 모듈입니다. (기본 설정: `"klay,net,personal"`)

host

string

(optional) network interface to open the listener socket on (default: "localhost").

port

int

(선택 사항) 리스너 소켓을 열기 위한 네트워크 포트입니다. (기본 설정: 8552)

cors

string

(optional) cross-origin resource sharing header to use (default: "").

apis

string

(선택 사항) 이 인터페이스를 통해 제공할 API 모듈입니다. (기본 설정: "klay,net,personal")

Return Value

Type	Description
bool	웹소켓 RPC 리스너가 열리면 `true`를 반환하고, 그렇지 않으면 `false`를 반환합니다.

Example

Console

> admin.startWS("127.0.0.1", 8552)
true

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_startWS","params":["127.0.0.1", 8552, "", "klay"],"id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":true}

admin_stopWS

stopWS 관리 메서드는 현재 열려있는 웹소켓 RPC 엔드포인트를 닫습니다. 노드는 하나의 웹소켓 엔드포인트를 실행할 수 있기 때문에 이 메서드에 매개변수는 필요하지 않으며, 엔드포인트가 닫혔는지 여부에 따라 불리언으로 결과를 반환합니다.

Client Method invocation

Client	Method invocation
Console	`admin.stopWS()`
RPC	`{"method": "admin_stopWS"}`

Console

admin.stopWS()

RPC

{"method": "admin_stopWS"}

Parameters

None

Return Value

Type	Description
bool	`true` if the endpoint was closed, `false` if not.

Example

Console

> admin.stopWS()
true

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_stopWS","id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":true}

admin_exportChain

exportChain 관리 메서드는 블록체인을 파일로 내보냅니다.

Client Method invocation

Client	Method invocation
Console	`admin.exportChain(fileName)`
RPC	`{"method": "admin_exportChain"}, "params": [fileName, startBlockNum, endBlockNum]}`

Console

admin.exportChain(fileName)

RPC

{"method": "admin_exportChain"}, "params": [fileName, startBlockNum, endBlockNum]}

Parameters

Name	Type	Description
fileName	string	블록체인을 내보낼 파일의 명확한 경로입니다.
startBlockNum	int	(optional) The first block number of the range to export.
endBlockNum	int	(optional) The last block number of the range.

Name

Type

Description

fileName

string

블록체인을 내보낼 파일의 명확한 경로입니다.

startBlockNum

int

(optional) The first block number of the range to export.

endBlockNum

int

(optional) The last block number of the range.

Return Value

Type	Description
bool	블록체인을 내보내면 `true`를 반환하고, 그렇지 않으면 `false`를 반환합니다.

Example

Console

> admin.exportChain("/tmp/chain.txt")
true
> admin.exportChain("/tmp/chain.txt", 555)
true
> admin.exportChain("/tmp/chain.txt", 1, 1000)
true

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_exportChain","params":["/tmp/chain.txt"],"id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":true}

admin_importChain

importChain 관리 메서드는 내보낸 블록체인을 파일에서 노드로 가져옵니다. 이 메서드는 Klaytn 노드에 존재하지 않았던 블록만을 가져옵니다. 이 메서드는 기존 체인에서 아무 데이터도 삭제하지 않습니다.

Client Method invocation

Client	Method invocation
Console	`admin.importChain(fileName)`
RPC	`{"method": "admin_importChain"}, "params": [fileName]}`

Console

admin.importChain(fileName)

RPC

{"method": "admin_importChain"}, "params": [fileName]}

Parameters

Name	Type	Description
fileName	string	가져올 블록체인을 담고 있는 파일의 명확한 경로입니다.

Name

Type

Description

fileName

string

가져올 블록체인을 담고 있는 파일의 명확한 경로입니다.

Return Value

Type	Description
bool	블록체인을 가져오면 `true`를 반환하고, 그렇지 않으면 `false`를 반환합니다.

Example

Console

> admin.importChain("/tmp/chain.txt")
true

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_importChain","params":["/tmp/chain.txt"],"id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":true}

admin_importChainFromString

importChainFromString는 블록들을 RLP 인코딩한 문자열을 사용해 체인을 Klaytn 노드에 가져오는 관리 메서드입니다. 이 메서드는 Klaytn 노드에 체인이 없을 때에만 정상적으로 동작합니다. This method does not delete any data of the existing chain.

Client Method invocation

Client	Method invocation
Console	`admin.importChainFromString(blockRlp)`
RPC	`{"method": "admin_importChainFromString"}, "params": [<blockRlp>]}`

Console

admin.importChainFromString(blockRlp)

RPC

{"method": "admin_importChainFromString"}, "params": [<blockRlp>]}

Parameters

Name Type Description

Name	Type	Description
blockRlp	string	불러올 블록들을 RLP 인코딩한 문자열입니다. (`debug.getBlockRlp`의 리턴값과 동일)

blockRlp

string

불러올 블록들을 RLP 인코딩한 문자열입니다. (debug.getBlockRlp의 리턴값과 동일)

Return Value

Type	Description
bool	블록체인을 가져오면 `true`를 반환하고, 그렇지 않으면 `false`를 반환합니다.

Example

Console

> admin.importChainFromString("f9071...080c0")
true

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_importChainFromString","params":["f9071...080c0"],"id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":true}

admin_startStateMigration

startStateMigration 관리 메서드는 상태 마이그레이션을 시작하고 이전 상태/스토리지 트리 노드를 제거합니다. 이 메서드는 Klaytn 노드의 스토리지 사용량을 절약할 수 있습니다. 이 메서드는 상태 마이그레이션을 시작하는 데에 실패하면 에러를 반환하고, 상태 마이그레이션을 시작하는 데에 성공하면 null를 반환합니다. 참고: 상태 마이그레이션 후에는, 예전 상태들을 기준으로 API를 호출할 수 없습니다.

Client Method invocation

Client	Method invocation
Console	`admin.startStateMigration()`
RPC	`{"method": "admin_startStateMigration"}`

Console

admin.startStateMigration()

RPC

{"method": "admin_startStateMigration"}

Parameters

None

Return Value

Type	Description
에러	상태 마이그레이션을 성공적으로 시작했다면 `null`을 반환하고, 그렇지 않으면 에러를 반환합니다.

Example

Console

> admin.startStateMigration()
null

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_startStateMigration","id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":null}

admin_stopStateMigration

stopStateMigration는 현재 실행중인 상태 마이그레이션 작업을 중단하는 관리 메서드입니다. 이 메서드는 파라미터를 받지 않으며, 상태 마이그레이션 작업이 중단되었는지에 따라 null 또는 에러를 반환합니다.

Client Method invocation

Client	Method invocation
Console	`admin.stopStateMigration()`
RPC	`{"method": "admin_stopStateMigration"}`

Console

admin.stopStateMigration()

RPC

{"method": "admin_stopStateMigration"}

Parameters

None

Return Value

Type Description

Type	Description
Error	상태 마이그레이션이 중단되었다면 `null`을 반환하고, 그렇지 않으면 에러를 반환합니다.

Error

상태 마이그레이션이 중단되었다면 null을 반환하고, 그렇지 않으면 에러를 반환합니다.

Example

Console

> admin.stopStateMigration()
true

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_stopStateMigration","id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":null}

admin_stateMigrationStatus

stateMigrationStatus 관리 메서드는 상태 마이그레이션 작업 정보를 반환합니다. 이 메서드는 파라미터를 받지 않으며, 현재 진행중인 상태 마이그레이션 작업에 대한 정보를 반환합니다.

Client Method invocation

Client	Method invocation
Console	`admin.stateMigrationStatus`
RPC	`{"method": "admin_stateMigrationStatus"}`

Console

admin.stateMigrationStatus

RPC

{"method": "admin_stateMigrationStatus"}

Parameters

None

Return Value

Name Type Description

Name	Type	Description
committed	int	`committed`는 상태 마이그레이션 작업에 의해 복제된 트리 노드들의 개수입니다.
err	Error	상태 마이그레이션이 성공적으로 완료되었다면 `null`을 반환하고, 그렇지 않으면 에러를 반환합니다.
isMigration	bool	상태 마이그레이션이 진행중이면 `true`를 반환하고, 그렇지 않으면 `false`를 반환합니다.
migrationBlockNumber	uint64	상태 마이그레이션이 시작된 블록 번호입니다. (상태 마이그레이션이 진행중이 아니라면 `0`.)
pending	int	`pending`은 상태 마이그레이션이 처리하지 않은 트리 노드 개수입니다.
progress	float64	`progress`는 퍼센트(%)로 표현한 상태 마이그레이션 진행 정도입니다.
read	int	`read`는 상태 마이그레이션이 읽어 들인 트리 노드 개수입니다.

committed

int

committed는 상태 마이그레이션 작업에 의해 복제된 트리 노드들의 개수입니다.

err

Error

상태 마이그레이션이 성공적으로 완료되었다면 null을 반환하고, 그렇지 않으면 에러를 반환합니다.

isMigration

bool

상태 마이그레이션이 진행중이면 true를 반환하고, 그렇지 않으면 false를 반환합니다.

migrationBlockNumber

uint64

상태 마이그레이션이 시작된 블록 번호입니다. (상태 마이그레이션이 진행중이 아니라면 0.)

pending

int

pending은 상태 마이그레이션이 처리하지 않은 트리 노드 개수입니다.

progress

float64

progress는 퍼센트(%)로 표현한 상태 마이그레이션 진행 정도입니다.

read

int

read는 상태 마이그레이션이 읽어 들인 트리 노드 개수입니다.

Example

Console

> admin.stateMigrationStatus
{
  committed: 1585169,
  err: "null",
  isMigration: true,
  migrationBlockNumber: 32527233,
  pending: 27677,
  progress: 0.3662109375,
  read: 1587473
}

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_stateMigrationStatus","id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":{"committed":14995692,"err":"null","isMigration":true,"migrationBlockNumber":32630836,"pending":19699,"progress":25,"read":14997777}}

admin_saveTrieNodeCacheToDisk

saveTrieNodeToDisk는 노드가 재시작될 시 캐시된 트리 노드를 재사용하기 위해 디스크에 저장하기 시작하는 관리 메서드입니다. $DATA_DIR/fastcache는 캐시된 트리 노드 테이터가 저장되고 또 로드되는 곳입니다. 저장 프로세스가 이미 실행 되었거나 트리 노드 캐시가 비활성화되었을 경우 이 메서드는 에러를 반환합니다. 이 기능은 Klaytn 1.5.3. 부터 지원됩니다.

Client Method invocation

Client	Method invocation
Console	`admin.saveTrieNodeCacheToDisk()`
RPC	`{"method": "admin_saveTrieNodeCacheToDisk"}`

Console

admin.saveTrieNodeCacheToDisk()

RPC

{"method": "admin_saveTrieNodeCacheToDisk"}

Parameters

None

Return Value

Type Description

Type	Description
Error	트리 노드 저장이 성공적으로 시작되었다면 `null`을 반환하고, 그렇지 않으면 에러를 반환합니다.

Error

트리 노드 저장이 성공적으로 시작되었다면 null을 반환하고, 그렇지 않으면 에러를 반환합니다.

Example

Console

> admin.saveTrieNodeCacheToDisk()
null

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_saveTrieNodeCacheToDisk", "id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":null}

admin_setMaxSubscriptionPerWSConn

setMaxSubscriptionPerWSConn는 하나의 웹소켓 연결에 허용된 최대 구독 수를 설정하는 관리 메서드입니다. 예를 들어, 최대 구독 수가 5로 설정되어 있는데 사용자가 klay_subscribe API를 통해 5개 이상을 요청할 시, "하나의 웹소켓 연결당 5개의 구독이 허용됩니다"라는 에러 메시지가 나타납니다. 이 기능은 Klaytn 1.6.0. 부터 지원됩니다.

Client Method invocation

Client	Method invocation
Console	`admin.setMaxSubscriptionPerWSConn(limit)`
RPC	`{"method": "admin_setMaxSubscriptionPerWSConn"}`

Console

admin.setMaxSubscriptionPerWSConn(limit)

RPC

{"method": "admin_setMaxSubscriptionPerWSConn"}

Parameters

Name	Type	Description
limit	int	하나의 WebSocket 연결 당 허용된 최대 구독 수

Name

Type

Description

limit

int

하나의 WebSocket 연결 당 허용된 최대 구독 수

Return Value

Type Description

Type	Description
Error	한계가 성공적으로 설정될 시 `null`를, 그렇지 않을 시 에러 메시지가 나타납니다.

Error

한계가 성공적으로 설정될 시 null를, 그렇지 않을 시 에러 메시지가 나타납니다.

Example

Console

> admin.setMaxSubscriptionPerWSConn(5)
null

HTTP RPC

$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"admin_setMaxSubscriptionPerWSConn", "params":[5], "id":1}' https://public-en-baobab.klaytn.net
{"jsonrpc":"2.0","id":1,"result":null}

PreviousBlockchain Inspection Nextpersonal

Last updated 6 months ago