Lattice Hub 文档
HTTP OpenAPI配置

配置分组

配置分组的创建与查询。

配置分组的创建与查询。

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

配置分组

配置分组 CRUD。写接口 body 多为 ConfigFileGroup 数组(Enrich 有时写成单对象)。

GET/config/v1/groups需要鉴权

查询配置分组

按命名空间/分组名/文件名搜索。

  • Authorizationheader · string必填

    登录返回的 token。

  • namespacequery · string可选

    命名空间;空表示全部。

  • groupquery · string可选

    分组名,模糊搜索。

  • fileNamequery · string可选

    配置文件名,模糊搜索。

  • offsetquery · integer可选

    偏移,默认 0。

  • limitquery · integer必填

    分页大小,最大 100,默认 100。

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

创建配置分组

写接口 body 多为 protobuf 消息数组;下列为单条对象字段(见 specification)。

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · ConfigFileGroup[]必填

    请求体为 ConfigFileGroup 的 JSON 数组:[{...}, ...]。下列字段为数组中单条对象的完整字段(含嵌套)。

  • idbody · string可选

    id

  • namebody · string必填

    name

  • namespacebody · string必填

    namespace

  • commentbody · string可选

    comment

  • businessbody · string可选

    business

  • departmentbody · string可选

    department

  • metadatabody · map<string,string>可选

    metadata

  • codebody · uint32必填

    业务码,成功多为 200000。

  • infobody · string可选

    提示信息。

  • configFileGroupbody · ConfigFileGroup可选

    返回中的 ConfigFileGroup 实体字段(批量接口在 responses[] 内)。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • namespacebody · string可选

      namespace

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • businessbody · string可选

      business

    • departmentbody · string可选

      department

    • metadatabody · map<string,string>可选

      metadata

    • file_countbody · uint64可选

      file_count

    • editablebody · bool可选

      删除操作标志位

    • deleteablebody · bool可选

      deleteable

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

更新配置分组

更新分组;body 为数组。

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · ConfigFileGroup[]必填

    请求体为 ConfigFileGroup 的 JSON 数组:[{...}, ...]。下列字段为数组中单条对象的完整字段(含嵌套)。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • namespacebody · string可选

    namespace

  • commentbody · string可选

    comment

  • businessbody · string可选

    business

  • departmentbody · string可选

    department

  • metadatabody · map<string,string>可选

    metadata

  • codebody · uint32必填

    业务码,成功多为 200000。

  • infobody · string可选

    提示信息。

  • configFileGroupbody · ConfigFileGroup可选

    返回中的 ConfigFileGroup 实体字段(批量接口在 responses[] 内)。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • namespacebody · string可选

      namespace

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • businessbody · string可选

      business

    • departmentbody · string可选

      department

    • metadatabody · map<string,string>可选

      metadata

    • file_countbody · uint64可选

      file_count

    • editablebody · bool可选

      删除操作标志位

    • deleteablebody · bool可选

      deleteable

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

删除配置分组

注意:控制面路径为 delette(历史拼写)。

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · ConfigFileGroup[]必填

    请求体为 ConfigFileGroup 的 JSON 数组;下列为单条字段。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • namespacebody · string可选

    namespace

  • commentbody · string可选

    comment

  • businessbody · string可选

    business

  • departmentbody · string可选

    department

  • metadatabody · map<string,string>可选

    metadata

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • ConfigFileGroupbody · ConfigFileGroup可选

    实体字段。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • namespacebody · string可选

      namespace

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • businessbody · string可选

      business

    • departmentbody · string可选

      department

    • metadatabody · map<string,string>可选

      metadata

    • file_countbody · uint64可选

      file_count

    • editablebody · bool可选

      editable

    • deleteablebody · bool可选

      deleteable

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

On this page