Lattice.Hub

Create, query, and update services.

Default Base URL: http://127.0.0.1:8090. Management APIs require Authorization (token from login).

Service basics

Service CRUD. Write bodies are Service arrays.

GET/naming/v1/servicesAuth required

List services

Paginated service list; name/namespace support fuzzy (*).

Parameters

Authorizationheader · stringrequired
Token from login.
namequery · stringoptional
Service name (fuzzy).
namespacequery · stringoptional
Namespace (fuzzy).
businessquery · stringoptional
Business.
departmentquery · stringoptional
Department.
hostquery · stringoptional
Filter by instance host.
portquery · stringoptional
Filter by instance port.
keysquery · stringoptional
Service metadata keys.
valuesquery · stringoptional
Service metadata values.
instance_keysquery · stringoptional
Instance metadata keys.
instance_valuesquery · stringoptional
Instance metadata values.
offsetquery · integeroptional
Offset.
limitquery · integeroptional
Page size, max 100.

Request

curl -sS 'http://127.0.0.1:8090/naming/v1/services?namespace=default&limit=20' \
  -H "Authorization: $TOKEN"

Response example

{
  "code": 200000,
  "info": "execute success",
  "services": [{ "name": "payment", "namespace": "default" }]
}

POST/naming/v1/servicesAuth required

Create services

Write bodies are usually protobuf message arrays; fields below are per-object (see specification).

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · Service[]required
Request body is a JSON array of Service: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringrequired
name
namespacebody · stringrequired
namespace
metadatabody · map<string,string>optional
metadata
portsbody · stringoptional
ports
businessbody · stringoptional
business
departmentbody · stringoptional
department
cmdb_mod1body · stringoptional
cmdb_mod1
cmdb_mod2body · stringoptional
cmdb_mod2
cmdb_mod3body · stringoptional
cmdb_mod3
commentbody · stringoptional
comment
ownersbody · stringoptional
owners
tokenbody · stringoptional
token
export_tobody · string[]optional
export_to

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
servicebody · Serviceoptional
Service entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- namespacebody · stringoptional
  namespace
- metadatabody · map<string,string>optional
  metadata
- portsbody · stringoptional
  ports
- businessbody · stringoptional
  business
- departmentbody · stringoptional
  department
- cmdb_mod1body · stringoptional
  cmdb_mod1
- cmdb_mod2body · stringoptional
  cmdb_mod2
- cmdb_mod3body · stringoptional
  cmdb_mod3
- commentbody · stringoptional
  comment
- ownersbody · stringoptional
  owners
- tokenbody · stringoptional
  token
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- revisionbody · stringoptional
  revision
- export_tobody · string[]optional
  export_to
- total_instance_countbody · uint32optional
  total_instance_count
- healthy_instance_countbody · uint32optional
  healthy_instance_count
- editablebody · booloptional
  editable
- deleteablebody · booloptional
  deleteable

Request

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"}]'

Response example

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

PUT/naming/v1/servicesAuth required

Update services

Update services; body is an array.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · Service[]required
Request body is a JSON array of Service: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringoptional
name
namespacebody · stringoptional
namespace
metadatabody · map<string,string>optional
metadata
portsbody · stringoptional
ports
businessbody · stringoptional
business
departmentbody · stringoptional
department
cmdb_mod1body · stringoptional
cmdb_mod1
cmdb_mod2body · stringoptional
cmdb_mod2
cmdb_mod3body · stringoptional
cmdb_mod3
commentbody · stringoptional
comment
ownersbody · stringoptional
owners
tokenbody · stringoptional
token
export_tobody · string[]optional
export_to

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
servicebody · Serviceoptional
Service entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- namespacebody · stringoptional
  namespace
- metadatabody · map<string,string>optional
  metadata
- portsbody · stringoptional
  ports
- businessbody · stringoptional
  business
- departmentbody · stringoptional
  department
- cmdb_mod1body · stringoptional
  cmdb_mod1
- cmdb_mod2body · stringoptional
  cmdb_mod2
- cmdb_mod3body · stringoptional
  cmdb_mod3
- commentbody · stringoptional
  comment
- ownersbody · stringoptional
  owners
- tokenbody · stringoptional
  token
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- revisionbody · stringoptional
  revision
- export_tobody · string[]optional
  export_to
- total_instance_countbody · uint32optional
  total_instance_count
- healthy_instance_countbody · uint32optional
  healthy_instance_count
- editablebody · booloptional
  editable
- deleteablebody · booloptional
  deleteable

Request

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"}]'

Response example

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

POST/naming/v1/services/deleteAuth required

Delete services

Delete services; body includes name + namespace.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · Service[]required
Request body is a JSON array of Service: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringoptional
name
namespacebody · stringoptional
namespace
metadatabody · map<string,string>optional
metadata
portsbody · stringoptional
ports
businessbody · stringoptional
business
departmentbody · stringoptional
department
cmdb_mod1body · stringoptional
cmdb_mod1
cmdb_mod2body · stringoptional
cmdb_mod2
cmdb_mod3body · stringoptional
cmdb_mod3
commentbody · stringoptional
comment
ownersbody · stringoptional
owners
tokenbody · stringoptional
token
export_tobody · string[]optional
export_to

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
servicebody · Serviceoptional
Service entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- namespacebody · stringoptional
  namespace
- metadatabody · map<string,string>optional
  metadata
- portsbody · stringoptional
  ports
- businessbody · stringoptional
  business
- departmentbody · stringoptional
  department
- cmdb_mod1body · stringoptional
  cmdb_mod1
- cmdb_mod2body · stringoptional
  cmdb_mod2
- cmdb_mod3body · stringoptional
  cmdb_mod3
- commentbody · stringoptional
  comment
- ownersbody · stringoptional
  owners
- tokenbody · stringoptional
  token
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- revisionbody · stringoptional
  revision
- export_tobody · string[]optional
  export_to
- total_instance_countbody · uint32optional
  total_instance_count
- healthy_instance_countbody · uint32optional
  healthy_instance_count
- editablebody · booloptional
  editable
- deleteablebody · booloptional
  deleteable

Request

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"}]'

Response example

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

GET/naming/v1/service/aliasesAuth required

List service aliases

List service aliases.

Parameters

Authorizationheader · stringrequired
Token from login.
servicequery · stringoptional
Target service.
namespacequery · stringoptional
Namespace.
limitquery · integeroptional
Page size.

Request

curl -sS 'http://127.0.0.1:8090/naming/v1/service/aliases?namespace=default&limit=20' \
  -H "Authorization: $TOKEN"

Response example

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

POST/naming/v1/service/aliasAuth required

Create service alias

Create an alias; fields follow ServiceAlias.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · ServiceAlias[]required
Request body is a JSON array of ServiceAlias: [{...}, ...]. Fields below are the full per-item schema (including nested).
servicebody · stringoptional
service
namespacebody · stringrequired
namespace
aliasbody · stringoptional
alias
alias_namespacebody · stringoptional
alias_namespace
typebody · enum(AliasType)optional
type enum: DEFAULT | CL5SID
ownersbody · stringoptional
owners
commentbody · stringoptional
comment
service_tokenbody · stringoptional
service_token
idbody · stringoptional
id

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
serviceAliasbody · ServiceAliasoptional
ServiceAlias entity fields (batch APIs nest under responses[]).
- servicebody · stringoptional
  service
- namespacebody · stringoptional
  namespace
- aliasbody · stringoptional
  alias
- alias_namespacebody · stringoptional
  alias_namespace
- typebody · enum(AliasType)optional
  type enum: DEFAULT | CL5SID
- ownersbody · stringoptional
  owners
- commentbody · stringoptional
  comment
- service_tokenbody · stringoptional
  service_token
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- idbody · stringoptional
  id
- editablebody · booloptional
  editable
- deleteablebody · booloptional
  deleteable

Request

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"}'

Response example

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

GET/naming/v1/services/allAuth required

All services in namespace

All services in namespace.

Parameters

Authorizationheader · stringrequired
Token from login.
namespacequery · stringrequired
namespace

Request

curl -sS -X GET 'http://127.0.0.1:8090/naming/v1/services/all' \
  -H "Authorization: $TOKEN"

Response example

{
  "code": 200000,
  "info": "execute success"
}

GET/naming/v1/services/countAuth required

Services count

Services count.

Parameters

Authorizationheader · stringrequired
Token from login.

Request

curl -sS -X GET 'http://127.0.0.1:8090/naming/v1/services/count' \
  -H "Authorization: $TOKEN"

Response example

{
  "code": 200000,
  "info": "execute success"
}

PUT/naming/v1/service/aliasAuth required

Update service alias

Update service alias.

Parameters

Authorizationheader · stringrequired
Token from login.
servicebody · stringoptional
service
namespacebody · stringoptional
namespace
aliasbody · stringoptional
alias
alias_namespacebody · stringoptional
alias_namespace
typebody · enum(AliasType)optional
type enum: DEFAULT | CL5SID
ownersbody · stringoptional
owners
commentbody · stringoptional
comment
service_tokenbody · stringoptional
service_token
idbody · stringoptional
id

Response fields

codebody · uint32required
Business code.
infobody · stringoptional
Info.
ServiceAliasbody · ServiceAliasoptional
Entity fields.
- servicebody · stringoptional
  service
- namespacebody · stringoptional
  namespace
- aliasbody · stringoptional
  alias
- alias_namespacebody · stringoptional
  alias_namespace
- typebody · enum(AliasType)optional
  type enum: DEFAULT | CL5SID
- ownersbody · stringoptional
  owners
- commentbody · stringoptional
  comment
- service_tokenbody · stringoptional
  service_token
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- idbody · stringoptional
  id
- editablebody · booloptional
  editable
- deleteablebody · booloptional
  deleteable

Request

curl -sS -X PUT 'http://127.0.0.1:8090/naming/v1/service/alias' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'

Response example

{
  "code": 200000,
  "info": "execute success"
}

POST/naming/v1/service/aliases/deleteAuth required

Delete service aliases

Delete service aliases.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · ServiceAlias[]required
JSON array of ServiceAlias; fields below are per-item.
servicebody · stringoptional
service
namespacebody · stringoptional
namespace
aliasbody · stringoptional
alias
alias_namespacebody · stringoptional
alias_namespace
typebody · enum(AliasType)optional
type enum: DEFAULT | CL5SID
ownersbody · stringoptional
owners
commentbody · stringoptional
comment
service_tokenbody · stringoptional
service_token
idbody · stringoptional
id

Response fields

codebody · uint32required
Business code.
infobody · stringoptional
Info.
ServiceAliasbody · ServiceAliasoptional
Entity fields.
- servicebody · stringoptional
  service
- namespacebody · stringoptional
  namespace
- aliasbody · stringoptional
  alias
- alias_namespacebody · stringoptional
  alias_namespace
- typebody · enum(AliasType)optional
  type enum: DEFAULT | CL5SID
- ownersbody · stringoptional
  owners
- commentbody · stringoptional
  comment
- service_tokenbody · stringoptional
  service_token
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- idbody · stringoptional
  id
- editablebody · booloptional
  editable
- deleteablebody · booloptional
  deleteable

Request

curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/service/aliases/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'

Response example

{
  "code": 200000,
  "info": "execute success"
}

Service basics

List services

Create services

Update services

Delete services

List service aliases

Create service alias

All services in namespace

Services count

Update service alias

Delete service aliases

On this page