quản trị viên
API dùng để kiểm soát nút Klaytn.
Quản trị viên
namespace cung cấp cho bạn quyền truy cập vào một số phương pháp RPC phi tiêu chuẩn. Họ sẽ cho phép bạn quyền kiểm soát chi tiết đối với phiên bản Klaytn của bạn, bao gồm nhưng không giới hạn đối với mạng ngang hàng và quản lý điểm cuối RPC.
admin_nodeInfo
Có thể truy vấn thuộc tính quản trị nodeInfo
đối với tất cả thông tin đã biết về nút Klaytn đang chạy ở mức độ chi tiết của mạng. Thuộc tính này bao gồm thông tin chung về nút như một thành phần tham gia của giao thức phủ P2P devp2p, cũng như thông tin chuyên biệt được thêm vào bởi mỗi giao thức ứng dụng đang chạy, ví dụ như klay
.
Bảng điều khiển
admin.nodeInfo
RPC
{"method": "admin_nodeInfo"}
Tham số
Không có
Giá trị trả về
Chuỗi JSON
Thông tin nút.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_datadir
Có thể truy vấn thuộc tính quản trị datadir
cho đường dẫn tuyệt đối của nút Klaytn đang chạy hiện đang sử dụng để lưu trữ tất cả các cơ sở dữ liệu của nó. Đường dẫn mặc định khác nhau tùy thuộc vào loại nút (kcn, kpn và ken) và loại hệ điều hành.
Bảng điều khiển
admin.datadir
RPC
{"method": "admin_datadir"}
Tham số
Không có
Giá trị trả về
chuỗi
Đường dẫn datadir
.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_peers
Có thể truy vấn thuộc tính quản trị peers
đối với tất cả thông tin đã biết về các nút từ xa được kết nối ở mức độ chi tiết của mạng. Thuộc tính này bao gồm thông tin chung về nút như một thành phần tham gia của giao thức phủ P2P devp2p, cũng như thông tin chuyên biệt được thêm vào bởi mỗi giao thức ứng dụng đang chạy.
Bảng điều khiển
admin.peers
RPC
{"method": "admin_peers"}
Tham số
Không có
Giá trị trả về
Chuỗi JSON
Thông tin về tất cả các mạng ngang hàng được kết nối.
Ví dụ
Bảng điều khiển
HTTP RPC
LƯU Ý: Tất cả các địa chỉ IP bên dưới là các ví dụ minh họa. Vui lòng thay thế chúng bằng địa chỉ IP thực trong môi trường thực thi của bạn.
admin_addPeer
addPeer
là một phương pháp quản trị yêu cầu thêm nút từ xa mới vào danh sách các nút tĩnh được theo dõi. Nút đó sẽ cố gắng duy trì kết nối liên tục với các nút này, thỉnh thoảng kết nối lại nếu kết nối từ xa gặp sự cố.
Phương thức này chấp nhận một đối số duy nhất kni, nghĩa là "Mã định danh mạng lưới Klaytn". Tương tự với khái niệm enode
trong geth. Đó là URL của máy ngang hàng từ xa để bắt đầu theo dõi và trả về BOOL
cho biết máy ngang hàng đó có được chấp nhận để theo dõi hoặc đã có lỗi xảy ra hay không.
Bảng điều khiển
admin.addPeer(url)
RPC
{"method": "admin_addPeer", "params": [url]}
Tham số
url
chuỗi
URL kni
của máy ngang hàng.
Giá trị trả về
bool
true
nếu máy ngang hàng được chấp nhận, ngược lại sẽ là false
.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_removePeer
removePeer
là một phương pháp quản trị yêu cầu xóa một nút khỏi danh sách nút tĩnh được theo dõi.
Phương thức này chấp nhận một đối số duy nhất kni, nghĩa là "Mã định danh mạng lưới Klaytn". Tương tự với khái niệm enode
trong geth. Đó là URL của máy ngang hàng từ xa sẽ bị xóa khỏi danh sách và trả về BOOL
cho biết liệu máy ngang hàng đã bị xóa hay xảy ra lỗi nào đó.
Bảng điều khiển
admin.removePeer(url)
RPC
{"method": "admin_removePeer", "params": [url]}
Tham số
url
chuỗi
URL kni
của máy ngang hàng.
Giá trị trả về
bool
true
nếu máy ngang hàng được chấp nhận, ngược lại sẽ là false
.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_startHTTP
LƯU Ý: API này sẽ thay thế cho admin_startRPC
. admin_startRPC
sẽ sớm ngừng hoạt động.
startHTTP
là phương pháp quản trị khởi chạy máy chủ web API JSON RPC dựa trên HTTP để xử lý các yêu cầu của máy khách.
Phương thức này sẽ trả về một cờ boolean để xác định xem trình nghe HTTP RPC đã được mở hay chưa. Xin lưu ý rằng chỉ có một điểm cuối HTTP được phép hoạt động bất kỳ lúc nào.
Bảng điều khiển
admin.startHTTP(host, port, cors, apis)
RPC
{"method": "admin_startHTTP", "params": [host, port, cors, apis]}
Tham số
máy chủ
chuỗi
(tùy chọn) giao diện mạng để mở socket trình nghe (mặc định: "localhost"
).
cổng
int
(tùy chọn) cổng mạng để mở socket trình nghe (mặc định: 8551
).
cors
chuỗi
apis
chuỗi
(tùy chọn) các mô-đun API để cung cấp trên giao diện này (mặc định: "klay,net,rpc"
).
Giá trị trả về
bool
true
nếu trình nghe HTTP RPC đã được mở, ngược lại sẽ là false
.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_stopHTTP
LƯU Ý: API này sẽ thay thế cho admin_stopRPC
. admin_stopRPC
sẽ sớm ngừng hoạt động.
stopHTTP
là một phương pháp quản trị đóng điểm cuối HTTP RPC hiện đang mở. Vì nút này chỉ có thể có một điểm cuối HTTP duy nhất đang chạy, nên phương pháp này không nhận tham số mà trả về giá trị boolean cho dù điểm cuối có bị đóng hay không.
Bảng điều khiển
admin.stopHTTP()
RPC
{"method": "admin_stopHTTP"}
Tham số
Không có
Giá trị trả về
bool
true
nếu điểm cuối đã đóng, ngược lại sẽ là false
.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_startWS
startWS
là phương pháp quản trị khởi chạy máy chủ web API JSON RPC dựa trên WebSocket để xử lý các yêu cầu của máy khách.
Phương thức này sẽ trả về một cờ boolean để xác định xem trình nghe WebSocket RPC đã được mở hay chưa. Xin lưu ý rằng chỉ có một điểm cuối WebSocket được phép hoạt động bất kỳ lúc nào.
Bảng điều khiển
admin.startWS(host, port, cors, apis)
RPC
{"method": "admin_startWS", "params": [host, port, cors, apis]}
Tham số
máy chủ
chuỗi
(tùy chọn) giao diện mạng để mở socket trình nghe (mặc định: "localhost"
).
cổng
int
(tùy chọn) cổng mạng để mở socket trình nghe (mặc định: 8552
).
cors
chuỗi
apis
chuỗi
(tùy chọn) các mô-đun API để cung cấp trên giao diện này (mặc định: "klay,net,personal"
).
Giá trị trả về
bool
true
nếu trình nghe WebSocket RPC đã được mở, ngược lại sẽ là false
.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_stopWS
stopWS
là một phương pháp quản trị đóng điểm cuối WebSocket RPC hiện đang mở. Vì nút này chỉ có thể có một điểm cuối WebSocket duy nhất đang chạy, nên phương pháp này không nhận tham số mà trả về giá trị boolean cho dù điểm cuối có bị đóng hay không.
Bảng điều khiển
admin.stopWS()
RPC
{"method": "admin_stopWS"}
Tham số
Không có
Giá trị trả về
bool
true
nếu điểm cuối đã đóng, ngược lại sẽ là false
.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_exportChain
exportChain
là một phương pháp quản trị xuất chuỗi khối thành một tệp.
Bảng điều khiển
admin.exportChain(fileName)
RPC
{"method": "admin_exportChain"}, "params": [fileName, startBlockNum, endBlockNum]}
Tham số
tên tệp tin
chuỗi
đường dẫn đủ điều kiện đến tệp mà chuỗi khối phải được xuất.
startBlockNum
int
(optional) The first block number of the range to export.
endBlockNum
int
(optional) The last block number of the range.
Giá trị trả về
bool
true
nếu chuỗi được xuất, ngược lại sẽ là false
.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_importChain
importChain
là một phương pháp quản trị để nhập một chuỗi đã xuất từ một tệp vào một nút. Phương thức này chỉ nhập các khối chưa có trong nút Klaytn. Phương thức này không xóa bất kỳ dữ liệu nào của chuỗi hiện có.
Bảng điều khiển
admin.importChain(fileName)
RPC
{"method": "admin_importChain"}, "params": [fileName]}
Tham số
tên tệp tin
chuỗi
đường dẫn đủ điều kiện đến tệp chứa chuỗi sẽ được nhập.
Giá trị trả về
bool
true
nếu chuỗi đã được nhập, ngược lại sẽ là false
.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_importChainFromString
importChainFromString
là phương pháp quản trị nhập chuỗi từ chuỗi khối được mã hóa RLP vào nút Klaytn. Phương thức này chỉ hoạt động nếu chưa có chuỗi nào trong nút Klaytn. Phương thức này không xóa bất kỳ dữ liệu nào của chuỗi hiện có.
Bảng điều khiển
admin.importChainFromString(blockRlp)
RPC
{"method": "admin_importChainFromString"}, "params": [<blockRlp>]}
Tham số
blockRlp
chuỗi
chuỗi được mã hóa RLP đại diện cho các khối được nhập. (bằng giá trị trả về của debug.getBlockRlp
)
Giá trị trả về
bool
true
nếu chuỗi đã được nhập hoặc ngược lại sẽ là false
.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_startStateMigration
startStateMigration
là một phương pháp quản trị để bắt đầu di chuyển trạng thái và loại bỏ các nút trie lưu trữ/trạng thái cũ. Nó có thể giúp tiết kiệm không gian lưu trữ của nút Klaytn. Phương thức này sẽ trả về lỗi nếu không thể bắt đầu di chuyển trạng thái hoặc null
khi bắt đầu thành công. LƯU Ý: Sau khi di chuyển trạng thái, nút không thể cung cấp API với các trạng thái trước đó.
Bảng điều khiển
admin.startStateMigration()
RPC
{"method": "admin_startStateMigration"}
Tham số
Không có
Giá trị trả về
Lỗi
null
nếu quá trình di chuyển trạng thái đã bắt đầu hoặc thông báo lỗi nếu chưa bắt đầu.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_stopStateMigration
stopStateMigration
là một phương pháp quản trị để dừng quá trình di chuyển trạng thái hiện đang chạy. Phương thức này không nhận tham số và trả về null
hoặc báo lỗi dù quá trình di chuyển trạng thái có bị dừng hay không.
Bảng điều khiển
admin.stopStateMigration()
RPC
{"method": "admin_stopStateMigration"}
Tham số
Không có
Giá trị trả về
Lỗi
null
nếu quá trình di chuyển trạng thái đã bị dừng hoặc báo lỗi nếu ngược lại.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_stateMigrationStatus
stateMigrationStatus
là một phương pháp quản trị trả về thông tin trạng thái của quá trình di chuyển trạng thái. Phương thức này không nhận tham số và trả về trạng thái của quá trình di chuyển trạng thái hiện đang chạy.
Bảng điều khiển
admin.stateMigrationStatus
RPC
{"method": "admin_stateMigrationStatus"}
Tham số
Không có
Giá trị trả về
đã lưu trữ
int
committed
là số nút trie đã được sao chép bởi quá trình di chuyển trạng thái.
lỗi
Lỗi
null
nếu quá trình di chuyển trạng thái kết thúc thành công hoặc báo lỗi nếu ngược lại.
isMigration
bool
true
nếu quá trình di chuyển trạng thái đang chạy hoặc ngược lại sẽ là false
.
migrationBlockNumber
uint64
blockNumber nơi quá trình di chuyển trạng thái bắt đầu. (0
nếu quá trình di chuyển trạng thái không chạy.)
đang chờ xử lý
int
pending
đại diện cho số lượng nút trie chưa được xử lý bởi quá trình di chuyển trạng thái.
tiến trình
float64
progress
là tiến trình di chuyển trạng thái được tính bằng phần trăm.
đọc
int
read
biểu thị số trie nút đã được đọc bởi quá trình di chuyển trạng thái.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_saveTrieNodeCacheToDisk
saveTrieNodeCacheToDisk
là một phương pháp quản trị bắt đầu lưu nút trie đã lưu trong bộ nhớ cache vào đĩa để sử dụng lại chúng khi nút khởi động lại. Dữ liệu nút trie đã lưu trong bộ nhớ cache sẽ được lưu trữ và tải từ $DATA_DIR/fastcache
. Phương thức này trả về lỗi nếu quá trình lưu đã được kích hoạt hoặc bộ nhớ đệm nút trie bị tắt. Tính năng này được hỗ trợ kể từ Klaytn 1.5.3.
Bảng điều khiển
admin.saveTrieNodeCacheToDisk()
RPC
{"method": "admin_saveTrieNodeCacheToDisk"}
Tham số
Không có
Giá trị trả về
Lỗi
null
nếu quá trình lưu nút trie đã bắt đầu hoặc báo lỗi nếu ngược lại.
Ví dụ
Bảng điều khiển
HTTP RPC
admin_setMaxSubscriptionPerWSConn
setMaxSubscriptionPerWSConn
là phương pháp quản trị đặt số lượt đăng ký tối đa được phép cho mỗi kết nối WebSocket. Ví dụ, nếu số lượng tối đa được đặt là năm và người dùng yêu cầu nhiều hơn năm lượt đăng ký thông qua API klay_subscribe
, một thông báo lỗi "Cho phép tối đa 5 đăng ký cho một kết nối WebSocket" sẽ được hiển thị. Tính năng này được hỗ trợ kể từ Klaytn 1.6.0.
Bảng điều khiển
admin.setMaxSubscriptionPerWSConn(limit)
RPC
{"method": "admin_setMaxSubscriptionPerWSConn"}
Tham số
giới hạn
int
Số lượt đăng ký tối đa cho phép trên mỗi kết nối WebSocket.
Giá trị trả về
Lỗi
null
nếu đặt giới hạn thành công; nếu không sẽ trả về một thông báo lỗi.
Ví dụ
Bảng điều khiển
HTTP RPC
Last updated