文档目录

节点代理 — API 参考

TRON 节点代理端点的节点密钥。

方法路径概览
GET/v1/node-keys列出节点密钥(密钥本身绝不返回)
POST/v1/node-keys创建节点密钥;密钥和端点地址仅显示一次
DELETE/v1/node-keys/{id}撤销节点密钥 (active = false)

基于 openapi.yaml 在构建时生成。基准 URL 为 https://api.tenergy.me/v1,Nile 测试网环境为 https://api-nile.tenergy.me/v1(详见环境说明)。下述每个请求均遵循身份鉴权规范进行签名,除非鉴权行另有说明。

列出节点密钥(密钥本身绝不返回)

GET /v1/node-keys · listNodeKeys

鉴权: API 密钥 (HMAC)。

权限检查与 GET /api-keys 相同(scope 为 keys.read)。used 统计当前活跃密钥数;limit 为 NODE_KEYS_PER_ACCOUNT(默认为 5)。

响应

状态码含义
200账户的节点密钥列表。

响应字段

字段类型必选说明
dataarray of object (NodeKey)是
data[].idstring是
data[].labelstring | null是
data[].activeboolean是
data[].created_atstring (date-time)是
data[].last_used_atstring (date-time) | null是
limitinteger是
usedinteger是

创建节点密钥;密钥和端点地址仅显示一次

POST /v1/node-keys · createNodeKey

鉴权: API 密钥 (HMAC)。

权限检查与 POST /api-keys 相同(scope 为 keys.create,需要 member editor 角色);无需新增 scope。节点密钥允许节点代理为经由它广播的交易自动购买 5 分钟能量订单,费用从本账户余额中扣除,除此之外无任何其它权限。系统仅存储其 SHA-256 哈希值。若账户已持有 NODE_KEYS_PER_ACCOUNT 个活跃密钥,则返回 3017 api_key_limit_reached。

请求体

JSON。

字段类型必选说明
labelstring

响应

状态码含义
201创建成功。key 与 endpoint 仅在本次响应中返回一次。
4093017 api_key_limit_reached。

响应字段

字段类型必选说明
idstring是
labelstring | null是
activeboolean是
created_atstring (date-time)是
last_used_atstring (date-time) | null是
keystring是26 字符 base32,128 位。
endpointstring是<PROXY_PUBLIC_HOST>/<key>。

撤销节点密钥 (active = false)

DELETE /v1/node-keys/{id} · revokeNodeKey

鉴权: API 密钥 (HMAC)。

权限检查与 DELETE /api-keys/{keyId} 相同(scope 为 keys.revoke)。代理将在其缓存 TTL 内停止接受该密钥。

请求参数

参数名位置类型必选说明
idpathstring是

响应

状态码含义
204已撤销。
404该账户下不存在指定的节点密钥。

    ↑ ↓ 切换 · Enter 打开 · Esc 关闭