Lattice.Hub
GitHub

Lattice Hub 文档
HTTP OpenAPI

管理面 Admin

运维管理接口：连接、Leader、日志、实例清理等。

运维管理接口：连接、Leader、日志、实例清理等。

默认 Base URL：http://127.0.0.1:8090。管理面接口需 Authorization（登录返回的 token）。

管理面 Admin

运维管理接口：连接、Leader、日志、清理等。

GET/admin/v1/apiserver/conn需要鉴权

查询 APIServer 连接

查询 APIServer 连接。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • protocolquery · string可选

    protocol

  • hostquery · string可选

    host

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/admin/v1/apiserver/conn' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/admin/v1/apiserver/conn/stats需要鉴权

连接统计

连接统计。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • protocolquery · string可选

    protocol

  • hostquery · string可选

    host

  • amountquery · integer可选

    amount

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/admin/v1/apiserver/conn/stats' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/admin/v1/apiserver/conn/close需要鉴权

关闭连接

关闭连接。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · ConnReq[]必填

    请求体为 ConnReq 的 JSON 数组；下列为单条字段。

  • protocolbody · string可选

    协议。

  • hostbody · string可选

    主机。

  • portbody · uint32可选

    端口。

响应字段

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • ConnReqbody · ConnReq可选

    实体字段。

    • protocolbody · string可选

      协议。

    • hostbody · string可选

      主机。

    • portbody · uint32可选

      端口。

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/admin/v1/apiserver/conn/close' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/admin/v1/memory/free需要鉴权

释放 OS 内存

释放 OS 内存。

参数

  • Authorizationheader · string必填

    登录返回的 token。

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/admin/v1/memory/free' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/admin/v1/instance/clean需要鉴权

清理实例

清理实例。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • idbody · string可选

    id

  • servicebody · string可选

    service

  • namespacebody · string可选

    namespace

  • hostbody · string可选

    host

  • portbody · uint32可选

    port

  • protocolbody · string可选

    protocol

  • versionbody · string可选

    version

  • prioritybody · uint32可选

    priority

  • weightbody · uint32可选

    weight

  • enable_health_checkbody · bool可选

    enable_health_check

  • health_checkbody · HealthCheck可选

    health_check

    • typebody · enum(HealthCheckType)可选

      type 枚举：UNKNOWN | HEARTBEAT | TCP | HTTP

    • heartbeatbody · HeartbeatHealthCheck可选

      heartbeat

      • ttlbody · uint32可选

        ttl

    • tcpbody · TcpHealthCheck可选

      tcp

      • intervalbody · uint32可选

        interval

    • httpbody · HttpHealthCheck可选

      http

      • intervalbody · uint32可选

        interval

      • pathbody · string可选

        path

  • healthybody · bool可选

    healthy

  • isolatebody · bool可选

    isolate

  • locationbody · Location可选

    location

    • regionbody · string可选

      region

    • zonebody · string可选

      zone

    • campusbody · string可选

      campus

  • metadatabody · map<string,string>可选

    metadata

响应字段

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • Instancebody · Instance可选

    实体字段。

    • idbody · string可选

      id

    • servicebody · string可选

      service

    • namespacebody · string可选

      namespace

    • hostbody · string可选

      host

    • portbody · uint32可选

      port

    • protocolbody · string可选

      protocol

    • versionbody · string可选

      version

    • prioritybody · uint32可选

      priority

    • weightbody · uint32可选

      weight

    • enable_health_checkbody · bool可选

      enable_health_check

    • health_checkbody · HealthCheck可选

      health_check

      • typebody · enum(HealthCheckType)可选

        type 枚举：UNKNOWN | HEARTBEAT | TCP | HTTP

      • heartbeatbody · HeartbeatHealthCheck可选

        heartbeat

        • ttlbody · uint32可选

          ttl

      • tcpbody · TcpHealthCheck可选

        tcp

        • intervalbody · uint32可选

          interval

      • httpbody · HttpHealthCheck可选

        http

        • intervalbody · uint32可选

          interval

        • pathbody · string可选

          path

    • healthybody · bool可选

      healthy

    • isolatebody · bool可选

      isolate

    • locationbody · Location可选

      location

      • regionbody · string可选

        region

      • zonebody · string可选

        zone

      • campusbody · string可选

        campus

    • metadatabody · map<string,string>可选

      metadata

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • revisionbody · string可选

      revision

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/admin/v1/instance/clean' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/admin/v1/instance/batchclean需要鉴权

批量清理实例

批量清理实例。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • batch_sizebody · uint32必填

    批量大小

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/admin/v1/instance/batchclean' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/admin/v1/instance/heartbeat需要鉴权

最近心跳

最近心跳。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • idquery · string可选

    id

  • servicequery · string可选

    service

  • namespacequery · string可选

    namespace

  • hostquery · string可选

    host

  • portquery · integer可选

    port

  • vpv_idquery · string可选

    vpv_id

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/admin/v1/instance/heartbeat' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/admin/v1/log/outputlevel需要鉴权

查询日志级别

查询日志级别。

参数

  • Authorizationheader · string必填

    登录返回的 token。

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/admin/v1/log/outputlevel' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
PUT/admin/v1/log/outputlevel需要鉴权

设置日志级别

设置日志级别。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • scopebody · string必填

    日志 scope

  • levelbody · string必填

    级别

请求示例
curl -sS -X PUT 'http://127.0.0.1:8090/admin/v1/log/outputlevel' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/admin/v1/leaders需要鉴权

Leader 选举列表

Leader 选举列表。

参数

  • Authorizationheader · string必填

    登录返回的 token。

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/admin/v1/leaders' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/admin/v1/leaders/release需要鉴权

释放 Leader

释放 Leader。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • electKeybody · string必填

    选举 key

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/admin/v1/leaders/release' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/admin/v1/cmdb/info需要鉴权

CMDB 信息

CMDB 信息。

参数

  • Authorizationheader · string必填

    登录返回的 token。

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/admin/v1/cmdb/info' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/admin/v1/report/clients需要鉴权

上报客户端列表

上报客户端列表。

参数

  • Authorizationheader · string必填

    登录返回的 token。

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/admin/v1/report/clients' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/admin/v1/pprof/enable需要鉴权

开关 pprof

开关 pprof。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • enablebody · bool必填

    是否开启

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/admin/v1/pprof/enable' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/admin/v1/server/functions需要鉴权

服务功能列表

服务功能列表。

参数

  • Authorizationheader · string必填

    登录返回的 token。

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/admin/v1/server/functions' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/admin/v1/system/configuration需要鉴权

系统配置

系统配置。

参数

  • Authorizationheader · string必填

    登录返回的 token。

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/admin/v1/system/configuration' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
GET/admin/v1/mainuser/exist需要鉴权

主账号是否存在

主账号是否存在。

参数

  • Authorizationheader · string必填

    登录返回的 token。

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/admin/v1/mainuser/exist' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/admin/v1/mainuser/create需要鉴权

初始化主账号

初始化主账号。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • passwordbody · string可选

    password

  • ownerbody · string可选

    owner

  • sourcebody · string可选

    source

  • auth_tokenbody · string可选

    auth_token

  • token_enablebody · bool可选

    token_enable

  • commentbody · string可选

    comment

  • user_typebody · string可选

    user_type

  • mobilebody · string可选

    mobile

  • emailbody · string可选

    email

  • metadatabody · map<string,string>可选

    metadata

响应字段

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • Userbody · User可选

    实体字段。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • passwordbody · string可选

      password

    • ownerbody · string可选

      owner

    • sourcebody · string可选

      source

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • user_typebody · string可选

      user_type

    • mobilebody · string可选

      mobile

    • emailbody · string可选

      email

    • metadatabody · map<string,string>可选

      metadata

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/admin/v1/mainuser/create' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}

策略

鉴权策略与资源授权。

命名空间

环境维度的 Namespace CRUD。

On this page

GET 查询 APIServer 连接GET 连接统计POST 关闭连接POST 释放 OS 内存POST 清理实例POST 批量清理实例GET 最近心跳GET 查询日志级别PUT 设置日志级别GET Leader 选举列表POST 释放 LeaderGET CMDB 信息GET 上报客户端列表POST 开关 pprofGET 服务功能列表GET 系统配置GET 主账号是否存在POST 初始化主账号