获取网络设置 (getNetwork)

功能描述

此 API 端点 POST /api/system/getNetwork 用于获取当前思源笔记实例配置的网络代理设置。

返回的配置信息是经过脱敏处理的,敏感字段(如果有)会被隐藏。

请求参数

此 API 不需要任何请求参数。发送一个空的 JSON 对象 {} 或不发送请求体即可。

请求示例:


{}
            

响应结果

成功的请求将返回一个 JSON 对象,code 为 0,data 包含一个名为 proxy 的对象,表示当前的网络代理配置。

proxy 对象通常包含以下字段 (如果未配置代理,可能为 null 或空对象):

响应示例 (配置了 HTTP 代理):


{
  "code": 0,
  "msg": "",
  "data": {
    "proxy": {
      "scheme": "http",
      "host": "127.0.0.1",
      "port": "1080"
    }
  }
}
            

响应示例 (未配置代理):


{
  "code": 0,
  "msg": "",
  "data": {
    "proxy": null // 或者可能是空对象 {}
  }
}
            

如果获取配置过程中发生错误,将返回非 0 的 code 和具体的错误信息 msg


{
  "code": -1,
  "msg": "get conf failed: error message", // 示例错误信息
  "data": null
}
            

在线测试

您可以在下方直接点击"发送请求"进行在线测试,以获取当前的网络代理设置。






响应结果:


            

注意:这是一个社区维护的文档,可能与官方最新版本存在差异。

如果您觉得本文档有帮助,可以考虑赞助支持:爱发电