节点管理接口

1.安全关闭节点

  • 接口全称:safetyClose
  • 接口简写:sfc
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/safetyClose
  • 请求参数:
    interface SafetyClose {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**是否需要关闭机器,true 表示关机 false 表示不关机 */
    isShutdown?: boolean;
    }
  • 返回参数:
    interface SafetyClose {
    /**是否成功 */
    success: boolean;
    result: {
        /**节点状态,详见节点状态 */
        machineStatus: number;
    };
    }

    2.设置节点密码

  • 接口全称:setSystemKey
  • 接口简写:ssk
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/setSystemKey
  • 请求参数:
    interface SetSystemKey {
    /**节点旧密码 */
    systemKeyOld: string;
    /**节点新密码 */
    systemKeyNew: string;
    /**是否要用非对称方式对新密码进行解密(true:使用非对称方式进行解密,false:不使用非对称方式进行解密,明文传输) */
    newKeyDecryptEnable?: boolean;
    }
  • 返回参数:
    interface SetSystemKey {
    /**是否成功 */
    success: boolean;
    result: boolean;
    }

    3.验证节点密码

  • 接口全称:verifySystemKey
  • 接口简写:vfs
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/verifySystemKey
  • 请求参数:
    interface VerifySystemKey {
    /**节点密码 */
    systemKey: string;
    }
  • 返回参数:
    interface VerifySystemKey {
    /**是否成功 */
    success: boolean;
    result: boolean;
    }

    4.增加节点管理员

  • 接口全称:addSystemAdmin
  • 接口简写:asa
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/addSystemAdmin
  • 请求参数:
    interface AddSystemAdmin {
    /**节点密码 */
    systemKey: string;
    /**节点管理员地址,管理员说明请参考<节点管理员> */
    systemAdminAddress: string;
    }
  • 返回参数:
    interface AddSystemAdmin {
    /**是否成功 */
    success: boolean;
    result: {
        systemAdmin: {
            /**管理员地址 */
            adminAddress: string;
            /**管理员增加时的时间戳 */
            adminAddTime: number;
            /**管理员名称 */
            adminName: string;
        };
    };
    }

    5.获得节点管理员

  • 接口全称:getSystemAdmin
  • 接口简写:gsa
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getSystemAdmin
  • 请求参数:
    interface GetSystemAdmin {
    /**节点密码 */
    systemKey: string;
    /**节点管理员地址,如果有传入地址,则返回该管理员地址的信息,如没有传入,则返回所有管理员的信息 */
    systemAdminAddress?: string;
    }
  • 返回参数:
    interface GetSystemAdmin {
    /**是否成功 */
    success: boolean;
    result: {
        systemAdmin: {
            /**管理员地址 */
            adminAddress: string;
            /**管理员增加时的时间戳 */
            adminAddTime: number;
            /**管理员名称 */
            adminName: string;
        }[];
    };
    }

    6.验证节点管理员

  • 接口全称:verifySystemAdmin
  • 接口简写:vsa
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/verifySystemAdmin
  • 请求参数:
    interface VerifySystemAdmin {
    /**加密后的管理员地址 */
    cryptoAdminAddress: string;
    }
  • 返回参数:
    interface VerifySystemAdmin {
    /**是否成功 */
    success: boolean;
    result: boolean;
    }

    7.删除节点管理员

  • 接口全称:delSystemAdmin
  • 接口简写:dsa
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/delSystemAdmin
  • 请求参数:
    interface DelSystemAdmin {
    /**节点密码 */
    systemKey: string;
    /**节点管理员地址,管理员说明请参考<节点管理员> */
    systemAdminAddress: string;
    }
  • 返回参数:
    interface DelSystemAdmin {
    /**是否成功 */
    success: boolean;
    result: boolean;
    }

    8.重置节点管理员

  • 接口全称:resetSystemAdmin
  • 接口简写:
  • 可调用方式:Http,Websocket
  • 调用方法:post
  • 接口url地址:/api/system/resetSystemAdmin
  • 请求参数:
    interface ResetSystemAdmin {
    /**节点密码 */
    systemKey: string;
    /**节点管理员地址,管理员说明请参考<节点管理员> */
    systemAdminAddresses: string[];
    }
  • 返回参数:
    interface ResetSystemAdmin {
    /**是否成功 */
    success: boolean;
    result: {
        systemAdmins: {
            /**管理员地址 */
            adminAddress: string;
            /**管理员增加时的时间戳 */
            adminAddTime: number;
            /**管理员名称 */
            adminName: string;
        }[];
    };
    }

    9.绑定节点账户

  • 接口全称:bindingAccount
  • 接口简写:ba
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/bindingAccount
  • 请求参数:
    interface BindingAccount {
    /**节点密码 */
    systemKey: string;
    /**加密后的受托人私钥 */
    cryptoSecret: string;
    /**加密后的受托人安全密钥 */
    secondSecret?: string;
    }
  • 返回参数:
    interface BindingAccount {
    /**是否成功 */
    success: boolean;
    result: {
        /**绑定的账户信息,JSON对象 */
        accountInfoAndAsset: MemInfoModel.AccountInfoAndAsset;
    };
    }

    10.获得节点受托人

  • 接口全称:getSystemDelegate
  • 接口简写:gsd
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getSystemDelegate
  • 请求参数:
    interface GetSystemDelegate {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    }
  • 返回参数:
    interface GetSystemDelegate {
    /**是否成功 */
    success: boolean;
    result?: {
        /**节点受托人公钥 */
        publicKey: string;
        /**节点受托人地址 */
        address: string;
        /**节点受托人设置成功时的时间戳 */
        addTime: number;
        /**受托人 */
        name: string | undefined;
    };
    }

    11.查询该节点注入的所有锻造者

  • 接口全称:getInjectGenerators
  • 接口简写:
  • 可调用方式:Http,Websocket
  • 调用方法:post
  • 接口url地址:/api/system/getInjectGenerators
  • 请求参数:
    interface GetInjectGenerators {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    }
  • 返回参数:
    interface GetInjectGenerators {
    /**是否成功 */
    success: boolean;
    result: {
        /**锻造者数组 */
        injectGenerators: {
            /**锻造者地址 */
            address: string;
            /**锻造者用户名 */
            username?: string;
        }[];
    };
    }

    12.查询该节点注入的锻造者详情信息

  • 接口全称:getSystemDelegateDetail
  • 接口简写:
  • 可调用方式:Http,Websocket
  • 调用方法:post
  • 接口url地址:/api/system/getSystemDelegateDetail
  • 请求参数:
    interface GetSystemDelegateDetail {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**受托人地址 */
    address: string;
    }
  • 返回参数:
    interface GetSystemDelegateDetail {
    /**是否成功 */
    success: boolean;
    result: {
        /**账户持有的主权益数量 */
        balance: string;
        /**账户的打块收益 */
        reward: string;
        /**账户累计锻造的区块数量 */
        forgerBlocks: number;
        /**账户地址 */
        address: string;
        /**是否位受托人 */
        isDelegate: boolean;
        /**账户别名 */
        username?: string;
    };
    }

    13.获得节点详情

  • 接口全称:getSystemNodeInfo
  • 接口简写:
  • 可调用方式:Http,Websocket
  • 调用方法:post
  • 接口url地址:/api/system/getSystemNodeInfo
  • 请求参数:
    interface GetSystemNodeInfo {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    }
  • 返回参数:
    interface GetSystemNodeInfo {
    /**是否成功 */
    success: boolean;
    result: {
        nodeInfo: {
            /**节点绑定地址列表 */
            addressList: {
                address: string;
                isDelegate: boolean;
                username?: string;
            }[];
            /**节点所绑定的地址累计收益 */
            accumulativeReward: string;
            /**当前高度 */
            height: number;
            /**节点版本 */
            version: string;
            /**链网络标识符 */
            magic: string;
            /**链名 */
            chainName: string;
            /**节点操作系统类型 */
            osType: string;
            /**创世块的签名 */
            gensisBlockSignature: string;
        };
    };
    }

    14.节点信息查询

  • 接口全称:miningMachineInfo
  • 接口简写:mmi
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/miningMachineInfo
  • 请求参数:
    interface MiningMachineInfo {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    }
  • 返回参数:
    interface MiningMachineInfo {
    /**是否成功 */
    success: boolean;
    result: {
        data: {
            /**主机名称 */
            hostname: string;
            /**更新功能端口 */
            updateServicePort: number;
            /**节点管理功能端口 */
            systemInfoPort: number;
            /**服务市场端口 */
            serviceMarketPort: number;
            /**区块链网络端口 */
            port: number;
            /**操作系统 */
            platform: string;
            /**CPU 核心数 */
            cpuCount: number;
            /**CPU 型号信息 */
            cpuModel: string;
            /**CPU 速率 */
            cpuSpeed: string;
            /**内存大小 单位: 字节 */
            totalMem: number;
            /**内存型号 */
            memModel: string;
            /**内存赫兹 */
            memHz: number;
            /**磁盘大小 单位: 字节 */
            totalDisk: number;
            /**磁盘类型 */
            diskModel: string;
            /**该节点是否设置了受托人 true: 已经设置受托人,false: 未设置受托人 */
            delegateStatus: boolean;
        };
    };
    }

    15.设置节点配置信息

  • 接口全称:setSystemConfig
  • 接口简写:ssc
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/setSystemConfig
  • 请求参数:
    interface SetSystemConfig {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**配置信息, 这里的参数都可为空 */
    config: AllPartial<Config.ConfigRevisable>;
    }
  • 返回参数:
    interface SetSystemConfig {
    /**是否成功 */
    success: boolean;
    result: boolean;
    }

    16.获得节点配置信息

  • 接口全称:getSystemConfigInfoDetail
  • 接口简写:gsci
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getSystemConfigInfoDetail
  • 请求参数:
    interface GetSystemConfigInfoDetail {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    }
  • 返回参数:
    interface GetSystemConfigInfoDetail {
    /**是否成功 */
    success: boolean;
    result: BFChainPC.Config.ConfigReadable;
    }

    17.获得节点状态(实时信息)

  • 接口全称:getRuntimeState
  • 接口简写:grs
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getRuntimeState
  • 请求参数:
    interface GetRuntimeState {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    }
  • 返回参数:
    interface GetRuntimeState {
    /**是否成功 */
    success: boolean;
    result: {
        /**内存信息,JSON对象 */
        memory: {
            /**驻留集大小,给这个进程分配了多少物理内存 */
            rss: number;
            /**堆的总大小,包含 3 个部分:1、已分配的内存,用于对象的创建和存储,对应于 heapUsed 2、未分配的但可用于分配的内存 3、未分配的但不能分配的内存 */
            heapTotal: number;
            /**已分配的内存,即堆中所有对象的总大小 */
            heapUsed: number;
            /**进程使用到的系统链接库所占用的内存 */
            external: number;
        };
        /**操作系统 */
        platform: 'aix' | 'android' | 'darwin' | 'freebsd' | 'linux' | 'openbsd' | 'sunos' | 'win32' | 'cygwin' | 'netbsd';
        /**CPU 核心数 */
        cpuCount: number;
        /**可用内存大小 */
        freemem: number;
        /**总共内存大小 */
        totalmen: number;
        /**CPU 使用率,单位:% */
        cpuUsage: number;
        /**CPU 平均负载 */
        cpuUsageV2: number[];
        /**CPU 型号信息 */
        cpuModel: string;
        /**进程信息,JSON对象 */
        process: {
            /**进程ID */
            pid: number;
            /**进程名称 */
            name?: string;
        };
    };
    }

    18.获得节点访问统计信息

  • 接口全称:getSystemMonitor
  • 接口简写:gsm
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getSystemMonitor
  • 请求参数:
    interface GetSystemMonitor {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**指定访问类型,包括访问 IP 的流量,次数,访问接口的次数,区块数量,事件数据等 */
    monitorType?: string;
    /**查询数量,例limit=10,表示可以查询10条数据。 */
    limit?: number;
    /**查询开始位置,例offset = 0,表示从第1行开始查询。 */
    offset?: number;
    }
  • 返回参数:
    interface GetSystemMonitor {
    /**是否成功 */
    success: boolean;
    result: {
        systemMonitor: {
            /**IP 统计信息 */
            requestIpMonitorInfo?: {
                /**IP信息对象,JSON对象 */
                    /**访问次数 */
                    requestCount: number;
                    /**访问错误次数 */
                    requestErrorCount: number;
                    /**访问拒绝次数 */
                    requestRejectCount: number;
                    /**下载流量 */
                    downloadFlow: number;
                    /**上行流量 */
                    uploadFlow: number;
                };
            };
            /**访问方式统计信息,JSON对象 */
            requestMethodInfo?: {
                /**访问方式统计信息,JSON对象 */
                    /**访问次数 */
                    count: number;
                };
            };
            /**访问路径统计信息,JSON对象 */
            requestPathInfo?: {
                /**访问路径统计信息,JSON对象 */
                    /**访问次数 */
                    count: number;
                };
            };
            /**访问 url 统计信息,JSON对象 */
            requestApiUrlInfo?: {
                /**访问 url 统计信息,JSON对象 */
                    /**访问次数 */
                    count: number;
                };
            };
            /**访问接口名称统计信息,JSON对象 */
            requestMethodNameInfo?: {
                /**访问接口名称统计信息,JSON对象 */
                    /**访问次数 */
                    count: number;
                };
            };
            /**访问账户统计信息,JSON对象 */
            requestAccountInfo?: {
                /**访问账户统计信息,JSON对象 */
            };
            /**节点事件的统计信息,JSON对象 */
            transaction?: {
                /**节点事件权益数量 */
                amount: string;
                /**节点事件手续费数量 */
                fee: string;
            };
            /**节点的各种事件数量统计,JSON对象 */
            trsCount?: {
                /**节点的各种事件数量统计,JSON对象 */
            };
            /**区块信息,JSON对象 */
            blockCount?: {
                /**区块高度 */
                height: number;
                /**区块生成时间戳 */
                time: number;
                /**区块奖励数量 */
                reward: string;
                /**区块大小 */
                blockSize: number;
                /**区块事件数量 */
                numberOfTransactions: number;
            }[];
        };
    };
    }

    19.获得节点运行日志类型

  • 接口全称:getSystemLoggerType
  • 接口简写:glt
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getSystemLoggerType
  • 请求参数:
    interface GetSystemLoggerType {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    }
  • 返回参数:
    interface GetSystemLoggerType {
    /**是否成功 */
    success: boolean;
    result: {
        /**日志类型,数组 */
        loggerType: {
            /**日志类型 */
            loggerType: string;
            /**日志文件名 */
            loggerName: string;
            /**该类型日志数量 */
            loggerAmount: number;
            /**该类型日志总大小,单位:字节 */
            loggerSize: number;
            /**该类型日志最后创建时间 */
            loggerUpdateTime: number;
        }[];
    };
    }

    20.获得节点运行日志列表

  • 接口全称:getSystemLoggerList
  • 接口简写:gll
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getSystemLoggerList
  • 请求参数:
    interface GetSystemLoggerList {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**日志类型 */
    loggerType: string;
    }
  • 返回参数:
    interface GetSystemLoggerList {
    /**是否成功 */
    success: boolean;
    result: {
        /**节点运行日志列表(某种类型的日志),JSON对象 */
        loggerList: {
            /**日志文件名 */
            logName: string;
            /**日志最后修改时间 */
            logUpdateTime: number;
            /**日志文件大小 */
            logSize: number;
            /**日志文件路径 */
            logPath: string;
        }[];
    };
    }

    21.获得节点运行日志内容

  • 接口全称:getSystemLoggerDetail
  • 接口简写:gld
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getSystemLoggerDetail
  • 请求参数:
    interface GetSystemLoggerDetail {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**日志文件名 */
    loggerName: string;
    /**查询数量,例limit=10,表示可以查询10条数据。 */
    limit?: number;
    /**查询开始位置,例offset = 0,表示从第1行开始查询。 */
    offset?: number;
    /**搜索的字符串 */
    searchString?: string;
    /**读取文件的方式 */
    readFileType?: {
        readFileAsync = 0,
        createReadStream = 1,
    };
    }
  • 返回参数:
    interface GetSystemLoggerDetail {
    /**是否成功 */
    success: boolean;
    result: {
        /**节点运行日志内容,数组格式,所有明细行的内容 */
        loggerDetail: string[];
        /**内容总行数 */
        linesTotal: number;
    };
    }

    22.删除节点运行日志

  • 接口全称:delSystemLogger
  • 接口简写:
  • 可调用方式:Http,Websocket
  • 调用方法:post
  • 接口url地址:/api/system/delSystemLogger
  • 请求参数:
    interface DelSystemLogger {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**日志文件名 */
    loggerName: string;
    }
  • 返回参数:
    interface DelSystemLogger {
    /**是否成功 */
    success: boolean;
    result: boolean;
    }

    23.获得节点邮箱地址

  • 接口全称:getEmailAddress
  • 接口简写:gea
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getEmailAddress
  • 请求参数:
    interface GetEmailAddress {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**需要查询的邮箱地址 */
    emailAddress?: string;
    }
  • 返回参数:
    interface GetEmailAddress {
    /**是否成功 */
    success: boolean;
    result: {
        /**邮箱接收地址 */
        emailToAddress: string;
        /**邮箱发送地址 */
        emailFromAddress: string;
        /**邮箱配置 */
        emailConfig: {
            /**邮箱配置类型,POP3/SMTP/IMAP */
            type: string;
            /**邮箱配置主机 */
            host?: string;
            /**邮箱配置端口 */
            port?: number;
            /**是否开启邮箱安全控制 */
            secureConnection?: boolean;
            /**是否开启 ssl */
            ssl?: boolean;
            /**是否开启 tls */
            tls?: boolean;
            /**中转邮箱配置信息 */
            auth?: {
                /**中转邮箱配置用户名 */
                user: string;
                /**中转邮箱配置密码 */
                pass: string;
            };
        };
    };
    }

    24.设置节点邮箱地址

  • 接口全称:setEmailAddress
  • 接口简写:sea
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/setEmailAddress
  • 请求参数:
    interface SetEmailAddress {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**邮箱接收地址 */
    emailToAddress: string;
    /**邮箱发送地址 */
    emailFromAddress: string;
    /**邮箱配置 */
    emailConfig: {
        /**邮箱配置类型,POP3/SMTP/IMAP */
        type: string;
        /**邮箱配置主机 */
        host?: string;
        /**邮箱配置端口 */
        port?: number;
        /**是否开启邮箱安全控制 */
        secureConnection?: boolean;
        /**是否开启 ssl */
        ssl?: boolean;
        /**是否开启 tls */
        tls?: boolean;
        /**中转邮箱配置信息 */
        auth?: {
            /**中转邮箱配置用户名 */
            user: string;
            /**中转邮箱配置密码 */
            pass: string;
        };
    };
    }
  • 返回参数:
    interface SetEmailAddress {
    /**是否成功 */
    success: boolean;
    result: boolean;
    }

    25.通过节点私钥验证节点受托人

  • 接口全称:verifySystemSecret
  • 接口简写:vss
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/verifySystemSecret
  • 请求参数:
    interface VerifySystemSecret {
    /**加密后的受托人私钥 */
    cryptoSecret: string;
    }
  • 返回参数:
    interface VerifySystemSecret {
    /**是否成功 */
    success: boolean;
    result: boolean;
    }

    26.设置节点访问白名单

  • 接口全称:setSystemWhiteList
  • 接口简写:swl
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/setSystemWhiteList
  • 请求参数:
    interface SetSystemWhiteList {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**白名单清单 */
    whiteList: string[];
    }
  • 返回参数:
    interface SetSystemWhiteList {
    /**是否成功 */
    success: boolean;
    result: boolean;
    }

    27.获得节点访问白名单

  • 接口全称:getSystemWhiteList
  • 接口简写:gwl
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getSystemWhiteList
  • 请求参数:
    interface GetSystemWhiteList {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    }
  • 返回参数:
    interface GetSystemWhiteList {
    /**是否成功 */
    success: boolean;
    result: {
        /**白名单列表 */
        whileList: string[];
    };
    }

    28.删除节点访问白名单

  • 接口全称:delSystemWhiteList
  • 接口简写:dwl
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/delSystemWhiteList
  • 请求参数:
    interface DelSystemWhiteList {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**白名单清单 */
    whiteList: string[];
    }
  • 返回参数:
    interface DelSystemWhiteList {
    /**是否成功 */
    success: boolean;
    result: boolean;
    }

    29.获得节点进程的网络相关信息

  • 接口全称:getProcessNetwork
  • 接口简写:gpn
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getProcessNetwork
  • 请求参数:
    interface GetProcessNetwork {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**查询数量,例limit=10,表示可以查询10条数据。 */
    limit?: number;
    /**查询开始位置,例offset = 0,表示从第1行开始查询。 */
    offset?: number;
    /**进程类型 */
    processType?: string;
    }
  • 返回参数:
    interface GetProcessNetwork {
    /**是否成功 */
    success: boolean;
    result?: {
        /**进程网络信息对象,JSON对象 */
        processNetwork: {
            /**进程类型 */
            processType: string;
            /**进程名称 */
            name: string;
            /**进程发送网络流量 */
            send: number;
            /**进程接收网络流量 */
            receive: number;
            /**进程发送接收的总网络流量 */
            sum: number;
        }[];
        count: number;
    };
    }

    30.获得节点进程CPU信息

  • 接口全称:getProcessCPU
  • 接口简写:gpc
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getProcessCPU
  • 请求参数:
    interface GetProcessCPU {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**查询数量,例limit=10,表示可以查询10条数据。 */
    limit?: number;
    /**查询开始位置,例offset = 0,表示从第1行开始查询。 */
    offset?: number;
    /**进程类型 */
    processType?: string;
    }
  • 返回参数:
    interface GetProcessCPU {
    /**是否成功 */
    success: boolean;
    result?: {
        /**进程 CPU 情况,JSON对象 */
        processCPU: {
            /**进程类型 */
            processType: string;
            /**进程名称 */
            name: string;
            /**进程 CPU 使用率 */
            percent: number;
            /**进程 CPU 状态 */
            state: string;
        }[];
        count: number;
    };
    }

    31.获得节点进程内存信息

  • 接口全称:getProcessMemory
  • 接口简写:gpm
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/getProcessMemory
  • 请求参数:
    interface GetProcessMemory {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    /**查询数量,例limit=10,表示可以查询10条数据。 */
    limit?: number;
    /**查询开始位置,例offset = 0,表示从第1行开始查询。 */
    offset?: number;
    /**进程类型 */
    processType?: string;
    }
  • 返回参数:
    interface GetProcessMemory {
    /**是否成功 */
    success: boolean;
    result?: {
        /**进程内存情况,JSON对象 */
        processMemory: {
            /**进程类型 */
            processType: string;
            /**进程名称 */
            name: string;
            /**进程共享内存大小 */
            share: number;
            /**进程专用内存大小 */
            rss: number;
        }[];
        count: number;
    };
    }

    32.定时发送节点状态

  • 接口全称:systemStatus
  • 接口简写:ess
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/systemStatus
  • 请求参数:
    interface SystemStatus {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    }
  • 返回参数:
    interface SystemStatus {
    /**是否成功 */
    success: boolean;
    result: {
        systemStatus: {
            /**CPU 使用率,数组 */
            cpusStatus: {
                /**CPU属于其系列中哪一代的代号 */
                model: string;
                /**CPU主频(时钟频率) */
                speed: number;
                /**耗时统计 */
                times: {
                    /**CPU在用户模式下花费的毫秒数 */
                    user: number;
                    /**CPU在良好模式下花费的毫秒数 */
                    nice: number;
                    /**CPU在系统模式下花费的毫秒数 */
                    sys: number;
                    /**CPU在空闲模式下花费的毫秒数 */
                    idle: number;
                    /**CPU在中断请求模式下花费的毫秒数 */
                    irq: number;
                };
            }[];
            /**内存使用状况 */
            memStatus: {
                /**可用内存大小 */
                freeMem: number;
                /**总共内存大小 */
                totalmem: number;
            };
            /**系统带宽 */
            bandwithStatus: {
                /**总共带宽 */
                total: number;
                /**使用带宽 */
                usage: number;
            };
            /**磁盘使用情况 */
            diskSpace: {
                /**可用磁盘大小 */
                free: number;
                /**总共磁盘大小 */
                size: number;
            };
            /**节点运行状态:0 离线,不可用 1 自由状态,有空闲资源可用 2 重建区块链 3 节点共识 4 重放区块 5 锻造区块 6 回滚区块*/
            machineStatus: number;
            /**受托人信息 */
            deletegateInfo: {
                /**投票收益率 */
                reward: string;
                /**当前轮次的投票数量 */
                voteCount: number;
                /**受托人锻造区块数量 */
                forgerBlocks: number;
            };
            /**矿机版本名称 */
            miningMachineVersionName: string;
            /**CPU使用率 */
            cpuUsage: number;
        };
    };
    }

    33.定时发送节点CPU,内存,网络信息

  • 接口全称:systemProcess
  • 接口简写:esp
  • 可调用方式:Http,Websocket,命令行,Grpc
  • 调用方法:post
  • 接口url地址:/api/system/systemProcess
  • 请求参数:
    interface SystemProcess {
    /**校验类型: 001 节点所有者校验 002 管理员校验 */
    verifyType: string;
    /**校验值,根据节点访问者的权限不同,节点拥有者为密码校验,管理员为地址校验 */
    verifyKey: string;
    }
  • 返回参数:
    interface SystemProcess {
    /**是否成功 */
    success: boolean;
    result: {
        /**节点 CPU,内存,网络信息,JSON对象 */
        systemProcess: {
            /**CPU 使用率,数组 */
            usageCPU: {
                // 进程数
                processCount: number;
                // 速度
                speed: number;
                // 正常运行时间
                runtime: number;
                // 线程数
                threadCount: number;
                // 句柄数
                handleCount: number;
                // CPU使用率
                CPUusage: number;
            };
            /**内存使用状况 */
            usageMemory: {
                // 物理内存
                physcial: number;
                // 物理内存使用
                physcialUsed: number;
                // 物理内存空闲
                physcialWait: number;
                // 虚拟内存
                virtual: number;
                // 虚拟内存使用
                virtualUsed: number;
                // 虚拟内存空闲
                virtualWait: number;
            };
            /**网络使用状况 */
            usageNetwork: {
                // 接收网络流量
                receive: number;
                // 发送网络流量
                send: number;
                // 总网络流量
                sum: number;
            };
            /**进程使用状况 */
            processData: {
                /**CPU使用百分比 */
                CPUPercent: number;
                /**内存使用百分比 */
                memoryPercent: number;
                /**每秒发送 */
                send: number;
                /**每秒接收 */
                receive: number;
            };
        };
    };
    }

    34.获取节点的信息,根据传入参数不同,返回不同形式的节点信息

  • 接口全称:getSystemInfo
  • 接口简写:
  • 可调用方式:Http,Websocket
  • 调用方法:get
  • 接口url地址:/api/system/getSystemInfo
  • 请求参数:无
  • 返回参数:
    interface GetSystemInfo {
    /**是否成功 */
    success: boolean;
    result: {
        data: {
            /**系统 ip */
            localIp: string;
            /**系统受托人 */
            delegateInfo: {
                /**节点受托人公钥 */
                publicKey: string;
                /**节点受托人地址 */
                address: string;
                /**节点受托人设置成功时的时间戳 */
                addTime: number;
                /**受托人 */
                name: string | undefined;
            } | undefined;
        };
    };
    }

    35.获得节点状态

  • 接口全称:getMachineStatus
  • 接口简写:
  • 可调用方式:Http,Websocket
  • 调用方法:get
  • 接口url地址:/api/system/getMachineStatus
  • 请求参数:无
  • 返回参数:
    interface GetMachineStatus {
    /**是否成功 */
    success: boolean;
    result: {
        /**节点状态 */
        machineStatus: number;
        /**节点最新的区块高度 */
        height?: number;
    };
    }