Lattice.Hub
GitHub

Lattice Hub 文档
HTTP OpenAPI服务

服务基本信息

服务创建、查询与更新。

服务创建、查询与更新。

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

服务基本信息

服务 CRUD。写接口 body 为 Service 数组。

GET/naming/v1/services需要鉴权

查询服务

按条件分页查询服务；name/namespace 支持模糊（*）。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • namequery · string可选

    服务名（可模糊）。

  • namespacequery · string可选

    命名空间（可模糊）。

  • businessquery · string可选

    业务。

  • departmentquery · string可选

    部门。

  • hostquery · string可选

    按实例 host 过滤。

  • portquery · string可选

    按实例 port 过滤。

  • keysquery · string可选

    服务 metadata key。

  • valuesquery · string可选

    服务 metadata value。

  • instance_keysquery · string可选

    实例 metadata key。

  • instance_valuesquery · string可选

    实例 metadata value。

  • offsetquery · integer可选

    偏移。

  • limitquery · integer可选

    分页大小，最大 100。

请求示例
curl -sS 'http://127.0.0.1:8090/naming/v1/services?namespace=default&limit=20' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success",
  "services": [{ "name": "payment", "namespace": "default" }]
}
POST/naming/v1/services需要鉴权

创建服务

写接口 body 多为 protobuf 消息数组；下列为单条对象字段（见 specification）。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · Service[]必填

    请求体为 Service 的 JSON 数组：[{...}, ...]。下列字段为数组中单条对象的完整字段（含嵌套）。

  • idbody · string可选

    id

  • namebody · string必填

    name

  • namespacebody · string必填

    namespace

  • metadatabody · map<string,string>可选

    metadata

  • portsbody · string可选

    ports

  • businessbody · string可选

    business

  • departmentbody · string可选

    department

  • cmdb_mod1body · string可选

    cmdb_mod1

  • cmdb_mod2body · string可选

    cmdb_mod2

  • cmdb_mod3body · string可选

    cmdb_mod3

  • commentbody · string可选

    comment

  • ownersbody · string可选

    owners

  • tokenbody · string可选

    token

  • export_tobody · string[]可选

    export_to

响应字段

  • codebody · uint32必填

    业务码，成功多为 200000。

  • infobody · string可选

    提示信息。

  • servicebody · Service可选

    返回中的 Service 实体字段（批量接口在 responses[] 内）。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • namespacebody · string可选

      namespace

    • metadatabody · map<string,string>可选

      metadata

    • portsbody · string可选

      ports

    • businessbody · string可选

      business

    • departmentbody · string可选

      department

    • cmdb_mod1body · string可选

      cmdb_mod1

    • cmdb_mod2body · string可选

      cmdb_mod2

    • cmdb_mod3body · string可选

      cmdb_mod3

    • commentbody · string可选

      comment

    • ownersbody · string可选

      owners

    • tokenbody · string可选

      token

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • revisionbody · string可选

      revision

    • export_tobody · string[]可选

      export_to

    • total_instance_countbody · uint32可选

      total_instance_count

    • healthy_instance_countbody · uint32可选

      healthy_instance_count

    • editablebody · bool可选

      editable

    • deleteablebody · bool可选

      deleteable

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/services' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"name":"payment","namespace":"default","owners":"platform"}]'
响应示例
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
PUT/naming/v1/services需要鉴权

更新服务

更新服务；body 为数组。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · Service[]必填

    请求体为 Service 的 JSON 数组：[{...}, ...]。下列字段为数组中单条对象的完整字段（含嵌套）。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • namespacebody · string可选

    namespace

  • metadatabody · map<string,string>可选

    metadata

  • portsbody · string可选

    ports

  • businessbody · string可选

    business

  • departmentbody · string可选

    department

  • cmdb_mod1body · string可选

    cmdb_mod1

  • cmdb_mod2body · string可选

    cmdb_mod2

  • cmdb_mod3body · string可选

    cmdb_mod3

  • commentbody · string可选

    comment

  • ownersbody · string可选

    owners

  • tokenbody · string可选

    token

  • export_tobody · string[]可选

    export_to

响应字段

  • codebody · uint32必填

    业务码，成功多为 200000。

  • infobody · string可选

    提示信息。

  • servicebody · Service可选

    返回中的 Service 实体字段（批量接口在 responses[] 内）。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • namespacebody · string可选

      namespace

    • metadatabody · map<string,string>可选

      metadata

    • portsbody · string可选

      ports

    • businessbody · string可选

      business

    • departmentbody · string可选

      department

    • cmdb_mod1body · string可选

      cmdb_mod1

    • cmdb_mod2body · string可选

      cmdb_mod2

    • cmdb_mod3body · string可选

      cmdb_mod3

    • commentbody · string可选

      comment

    • ownersbody · string可选

      owners

    • tokenbody · string可选

      token

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • revisionbody · string可选

      revision

    • export_tobody · string[]可选

      export_to

    • total_instance_countbody · uint32可选

      total_instance_count

    • healthy_instance_countbody · uint32可选

      healthy_instance_count

    • editablebody · bool可选

      editable

    • deleteablebody · bool可选

      deleteable

请求示例
curl -sS -X PUT 'http://127.0.0.1:8090/naming/v1/services' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"name":"payment","namespace":"default","comment":"updated"}]'
响应示例
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
POST/naming/v1/services/delete需要鉴权

删除服务

删除服务；body 含 name + namespace。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · Service[]必填

    请求体为 Service 的 JSON 数组：[{...}, ...]。下列字段为数组中单条对象的完整字段（含嵌套）。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • namespacebody · string可选

    namespace

  • metadatabody · map<string,string>可选

    metadata

  • portsbody · string可选

    ports

  • businessbody · string可选

    business

  • departmentbody · string可选

    department

  • cmdb_mod1body · string可选

    cmdb_mod1

  • cmdb_mod2body · string可选

    cmdb_mod2

  • cmdb_mod3body · string可选

    cmdb_mod3

  • commentbody · string可选

    comment

  • ownersbody · string可选

    owners

  • tokenbody · string可选

    token

  • export_tobody · string[]可选

    export_to

响应字段

  • codebody · uint32必填

    业务码，成功多为 200000。

  • infobody · string可选

    提示信息。

  • servicebody · Service可选

    返回中的 Service 实体字段（批量接口在 responses[] 内）。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • namespacebody · string可选

      namespace

    • metadatabody · map<string,string>可选

      metadata

    • portsbody · string可选

      ports

    • businessbody · string可选

      business

    • departmentbody · string可选

      department

    • cmdb_mod1body · string可选

      cmdb_mod1

    • cmdb_mod2body · string可选

      cmdb_mod2

    • cmdb_mod3body · string可选

      cmdb_mod3

    • commentbody · string可选

      comment

    • ownersbody · string可选

      owners

    • tokenbody · string可选

      token

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • revisionbody · string可选

      revision

    • export_tobody · string[]可选

      export_to

    • total_instance_countbody · uint32可选

      total_instance_count

    • healthy_instance_countbody · uint32可选

      healthy_instance_count

    • editablebody · bool可选

      editable

    • deleteablebody · bool可选

      deleteable

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/services/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"name":"payment","namespace":"default"}]'
响应示例
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
GET/naming/v1/service/aliases需要鉴权

查询服务别名

查询服务别名列表。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • servicequery · string可选

    指向的服务名。

  • namespacequery · string可选

    命名空间。

  • limitquery · integer可选

    分页大小。

请求示例
curl -sS 'http://127.0.0.1:8090/naming/v1/service/aliases?namespace=default&limit=20' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
POST/naming/v1/service/alias需要鉴权

创建服务别名

创建别名；字段见 ServiceAlias。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · ServiceAlias[]必填

    请求体为 ServiceAlias 的 JSON 数组：[{...}, ...]。下列字段为数组中单条对象的完整字段（含嵌套）。

  • servicebody · string可选

    service

  • namespacebody · string必填

    namespace

  • aliasbody · string可选

    alias

  • alias_namespacebody · string可选

    alias_namespace

  • typebody · enum(AliasType)可选

    type 枚举：DEFAULT | CL5SID

  • ownersbody · string可选

    owners

  • commentbody · string可选

    comment

  • service_tokenbody · string可选

    service_token

  • idbody · string可选

    id

响应字段

  • codebody · uint32必填

    业务码，成功多为 200000。

  • infobody · string可选

    提示信息。

  • serviceAliasbody · ServiceAlias可选

    返回中的 ServiceAlias 实体字段（批量接口在 responses[] 内）。

    • servicebody · string可选

      service

    • namespacebody · string可选

      namespace

    • aliasbody · string可选

      alias

    • alias_namespacebody · string可选

      alias_namespace

    • typebody · enum(AliasType)可选

      type 枚举：DEFAULT | CL5SID

    • ownersbody · string可选

      owners

    • commentbody · string可选

      comment

    • service_tokenbody · string可选

      service_token

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • idbody · string可选

      id

    • editablebody · bool可选

      editable

    • deleteablebody · bool可选

      deleteable

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/service/alias' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"service":"payment","namespace":"default","alias":"pay","alias_namespace":"default"}'
响应示例
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
GET/naming/v1/services/all需要鉴权

命名空间下全部服务

命名空间下全部服务。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • namespacequery · string必填

    namespace

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

服务数量

服务数量。

参数

  • Authorizationheader · string必填

    登录返回的 token。

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

更新服务别名

更新服务别名。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • servicebody · string可选

    service

  • namespacebody · string可选

    namespace

  • aliasbody · string可选

    alias

  • alias_namespacebody · string可选

    alias_namespace

  • typebody · enum(AliasType)可选

    type 枚举：DEFAULT | CL5SID

  • ownersbody · string可选

    owners

  • commentbody · string可选

    comment

  • service_tokenbody · string可选

    service_token

  • idbody · string可选

    id

响应字段

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • ServiceAliasbody · ServiceAlias可选

    实体字段。

    • servicebody · string可选

      service

    • namespacebody · string可选

      namespace

    • aliasbody · string可选

      alias

    • alias_namespacebody · string可选

      alias_namespace

    • typebody · enum(AliasType)可选

      type 枚举：DEFAULT | CL5SID

    • ownersbody · string可选

      owners

    • commentbody · string可选

      comment

    • service_tokenbody · string可选

      service_token

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • idbody · string可选

      id

    • editablebody · bool可选

      editable

    • deleteablebody · bool可选

      deleteable

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

删除服务别名

删除服务别名。

参数

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · ServiceAlias[]必填

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

  • servicebody · string可选

    service

  • namespacebody · string可选

    namespace

  • aliasbody · string可选

    alias

  • alias_namespacebody · string可选

    alias_namespace

  • typebody · enum(AliasType)可选

    type 枚举：DEFAULT | CL5SID

  • ownersbody · string可选

    owners

  • commentbody · string可选

    comment

  • service_tokenbody · string可选

    service_token

  • idbody · string可选

    id

响应字段

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • ServiceAliasbody · ServiceAlias可选

    实体字段。

    • servicebody · string可选

      service

    • namespacebody · string可选

      namespace

    • aliasbody · string可选

      alias

    • alias_namespacebody · string可选

      alias_namespace

    • typebody · enum(AliasType)可选

      type 枚举：DEFAULT | CL5SID

    • ownersbody · string可选

      owners

    • commentbody · string可选

      comment

    • service_tokenbody · string可选

      service_token

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • idbody · string可选

      id

    • editablebody · bool可选

      editable

    • deleteablebody · bool可选

      deleteable

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

命名空间

环境维度的 Namespace CRUD。

服务契约

服务契约查询与客户端上报。

On this page

GET 查询服务POST 创建服务PUT 更新服务POST 删除服务GET 查询服务别名POST 创建服务别名GET 命名空间下全部服务GET 服务数量PUT 更新服务别名POST 删除服务别名