The Microservice Registry API on sillysky.net

CRecordForwardToMicroServiceInstance

Tue, 09 Dec 2025 00:00:00 +0000

Send a message to the microservice registry, which forwards it to a desired microservice.

This message belongs to the microservice registry API.

{
  "id": "4dad52bd-3071-46d9-a79b-c5188e311131",
  "name": "FORWARD_TO_MICRO_SERVICE_INSTANCE",
  "isNanoService": "false",
  "description": "Forward a message to an instance of a given microservice ID.\nIf more than one instance is registered, forward the message to a random instance.",
  "slots": [
    {
      "key": "1",
      "name": "MESSAGE",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "MESSAGE",
      "description": "The message to forward."
    },
    {
      "key": "2",
      "name": "MICRO_SERVICE_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ID",
      "description": "The microservice to search for."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	MESSAGE	REQUEST	true	MESSAGE	The message to forward.
2	MICRO_SERVICE_ID	REQUEST	true	ID	The microservice to search for.

Usage

Example of use (after generating of the class CRecordForwardToMicroServiceInstance):

CRecordGetMicroServiceIds

Tue, 09 Dec 2025 00:00:00 +0000

Retrieve all IDs of the registered microservices.

This message belongs to the microservice registry API.

{
  "id": "8035c42e-2996-4b43-8b90-136298ede09d",
  "name": "GET_MICRO_SERVICE_IDS",
  "isNanoService": "false",
  "description": "Get the IDs of the registered microservices.",
  "slots": [
    {
      "key": "90005",
      "name": "MICRO_SERVICE_IDS",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "ID_ARRAY",
      "description": "The IDs of the registered microservices."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
90005	MICRO_SERVICE_IDS	REQUEST	false	ID_ARRAY	The IDs of the registered microservices.

Usage

Example of use (after generating of the class CRecordGetMicroServiceIds):

CRecordGetMicroServiceInstance

Tue, 09 Dec 2025 00:00:00 +0000

This message is used when you need the address of an instance of a microservice.

This message belongs to the microservice registry API.

{
  "id": "ddadb3e0-98b9-4e59-849d-369b079cbc1d",
  "name": "GET_MICRO_SERVICE_INSTANCE",
  "isNanoService": "false",
  "description": "Requests the target address of a microservice instance selected by the microservice registry.",
  "slots": [
    {
      "key": "1",
      "name": "MICRO_SERVICE_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ID",
      "description": "The ID of the microservice for which an instance is being searched."
    },
    {
      "key": "2",
      "name": "OWNER",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "TARGET_ADDRESS",
      "description": "The address of the microservice instance selected by the microservice registry."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	MICRO_SERVICE_ID	REQUEST	true	ID	The ID of the microservice for which an instance is being searched.
2	OWNER	RESPONSE	false	TARGET_ADDRESS	The address of the microservice instance selected by the microservice registry.

Usage

Example of use (after generating of the class CRecordGetMicroServiceInstance):

CRecordGetMicroServiceInstances

Tue, 09 Dec 2025 00:00:00 +0000

This message is used when you need one instance of each of the specified microservices.

This message belongs to the microservice registry API.

{
  "id": "c5557e3e-2a2c-45c7-89b5-39d9286d317b",
  "name": "GET_MICRO_SERVICE_INSTANCES",
  "isNanoService": "false",
  "description": "Get the target addresses of the given microservice IDs.\nIf more than one instance is registered, random instance are chosen.",
  "slots": [
    {
      "key": "1",
      "name": "MICRO_SERVICE_IDS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ID_ARRAY",
      "description": "The microservices to search for."
    },
    {
      "key": "2",
      "name": "MICRO_SERVICE_INSTANCES",
      "direction": "RESPONSE",
      "presenceConstraint": "OPTIONAL",
      "type": "RECORD_ARRAY",
      "description": "The instances of the given microservices."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	MICRO_SERVICE_IDS	REQUEST	true	ID_ARRAY	The microservices to search for.
1	MICRO_SERVICE_INSTANCES	RESPONSE	false	RECORD_ARRAY	The instances of the given microservices.

Usage

Example of use (after generating of the class CRecordGetMicroServiceInstances):

CRecordGetMicroServices

Tue, 09 Dec 2025 00:00:00 +0000

This message is used to fetch the registered microservices.

This message belongs to the microservice registry API.

{
  "id": "5f7e230e-cc3e-4860-b2d1-f1dba272e85b",
  "name": "GET_MICRO_SERVICES",
  "isNanoService": "false",
  "description": "Get the registered microservices.",
  "slots": [
    {
      "key": "90003",
      "name": "MICRO_SERVICES",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "RECORD_ARRAY",
      "description": "The registered microservices."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
90003	MICRO_SERVICES	REQUEST	false	RECORD_ARRAY	An array containing descriptions of the registered microservices.
Records are from type CRecordMicroService.

Usage

Example of use (after generating of the class CRecordGetMicroServices):

CRecordMicroService

Tue, 09 Dec 2025 00:00:00 +0000

This data record describes a microservice.

It serves as a pure data record.

The class that corresponds to this data is the CMicroServiceDescription.

{
  "id": "62e0f5e4-4410-4308-ae2d-f69e6ac05481",
  "name": "MICRO_SERVICE",
  "description": "A microservice.",
  "slots": [
    {
      "key": "1",
      "name": "ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ID",
      "description": "The ID of the microservice."
    },
    {
      "key": "2",
      "name": "DESCRIPTION",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "STRING",
      "description": "The descriptive text."
    },
    {
      "key": "3",
      "name": "API",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "RECORD_ARRAY",
      "description": "The API of the microservice.\nThe type of each record is CRecordDescriptionOfRecord."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	ID	REQUEST	true	ID	The ID of the microservice.
2	DESCRIPTION	REQUEST	true	STRING	The descriptive text.
3	API	REQUEST	true	RECORD_ARRAY	The API of the microservice.
The type of each record is CRecordDescriptionOfRecord.

Record Usage

In nyssr.net, we typically don't exchange interfaces between projects. Instead, we use platform-independent Records to describe message formats.

CRecordMicroServiceInstance

Tue, 09 Dec 2025 00:00:00 +0000

This data record contains the information about a single microservice instance.

This message belongs to the microservice registry API.

{
  "id": "116d6164-0769-4774-92d6-258b0807163a",
  "name": "MICRO_SERVICE_INSTANCE",
  "description": "A microservice instance.",
  "slots": [
    {
      "key": "1",
      "name": "MICRO_SERVICE_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ID",
      "description": "The microservice ID."
    },
    {
      "key": "2",
      "name": "MICRO_SERVICE_INSTANCE_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ID",
      "description": "The microservice instance ID."
    },
    {
      "key": "3",
      "name": "MICRO_SERVICE_ADDRESS",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "TARGET_ADDRESS",
      "description": "The microservice target address."
    },
    {
      "key": "4",
      "name": "TIME_ADDED",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ZONED_DATE_TIME",
      "description": "The time the microservice instance has been added."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	MICRO_SERVICE_ID	REQUEST	true	ID	The microservice ID.
2	MICRO_SERVICE_INSTANCE_ID	REQUEST	true	ID	The microservice instance ID.
3	MICRO_SERVICE_ADDRESS	REQUEST	true	TARGET_ADDRESS	The microservice target address.
4	TIME_ADDED	REQUEST	true	ZONED_DATE_TIME	The time the microservice instance has been added.

Usage

Example of use: see here.

CRecordRegisterMicroService

Tue, 09 Dec 2025 00:00:00 +0000

This message is used to register microservices.

This message belongs to the microservice registry API.

{
  "id": "be46c53e-e544-4e76-8c44-01f8c144254c",
  "name": "REGISTER_MICRO_SERVICE",
  "isNanoService": "false",
  "description": "Register a microservice.",
  "slots": [
    {
      "key": "1",
      "name": "MICRO_SERVICE",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "RECORD",
      "description": "The record of a single microservice to register."
    },
    {
      "key": "2",
      "name": "INSTANCE_ID",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "ID",
      "description": "Optional: The instance ID."
    },
    {
      "key": "3",
      "name": "ADDRESS",
      "direction": "REQUEST",
      "presenceConstraint": "OPTIONAL",
      "type": "TARGET_ADDRESS",
      "description": "Optional: The address of the microservice instance."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	MICRO_SERVICE	REQUEST	false	RECORD	The record of a single microservice to register.
2	INSTANCE_ID	REQUEST	false	ID	Optional: The instance ID.
3	ADDRESS	REQUEST	false	TARGET_ADDRESS	Optional: The address of the microservice instance.

Usage

Example of use (after generating of the class CRecordRegisterMicroService):

CRecordRemoveMicroServiceInstance

Tue, 09 Dec 2025 00:00:00 +0000

When a microservice instance is removed, this message notifies the microservice registry. The registry will then delete the reference to this instance as well.

This message belongs to the microservice registry API.

{
  "id": "faf04666-44a8-418f-91d6-3c78eb35cbfc",
  "name": "REMOVE_MICRO_SERVICE_INSTANCE",
  "description": "Remove a single microservice instance.",
  "isNanoService": "false",
  "slots": [
    {
      "key": "1",
      "name": "MICRO_SERVICE_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ID",
      "description": "The ID of the microservice."
    },
    {
      "key": "2",
      "name": "MICRO_SERVICE_INSTANCE_ID",
      "direction": "REQUEST",
      "presenceConstraint": "MANDATORY",
      "type": "ID",
      "description": "The ID of the microservice instance."
    }
  ]
}

Slot Description

Key	Name	Direction	Presence Constraint	Type	Description
1	MICRO_SERVICE_ID	REQUEST	true	ID	The ID of the microservice.
2	MICRO_SERVICE_INSTANCE_ID	REQUEST	true	ID	The ID of the microservice instance.

Usage

Example of use (after generating of the class CRecordRemoveMicroServiceInstance):