Updated on 2023-07-19 GMT+08:00

MicroService

Table 1 Parameters

Parameter

Mandatory

Type

Description

serviceId

No

String

Microservice ID, which must be unique. The value contains 1 to 64 characters. Regular expression: ^.*$.

environment

No

String

Microservice environment. Value: Empty value, development, testing, acceptance, or production.

appId

No

String

Application ID, which must be unique. The value contains 1 to 160 characters. Regular expression: ^[a-zA-Z0-9]*$|^[a-zA-Z0-9][a-zA-Z0-9_\-.]*[a-zA-Z0-9]$.

serviceName

Yes

String

Microservice name, which must be unique in an application. The value contains 1 to 128 characters. Regular expression: ^[a-zA-Z0-9]*$|^[a-zA-Z0-9][a-zA-Z0-9_\-.]*[a-zA-Z0-9]$.

version

No

String

Microservice version. The value contains 1 to 64 characters. Regular expression: ^[0-9]*$|^[0-9]+(\.[0-9]+)*$.

description

No

String

Description of a microservice. The value can contain up to 256 characters.

level

No

String

Microservice level.

  • FRONT
  • MIDDLE
  • BACK

timestamp

No

String

Microservice registration time.

schemas

No

Array of String

Foreign key ID of a microservice access schema. The array length supports up to 100 schemas.

status

No

String

Microservice status. Value: UP or DOWN. Default value: UP.

paths

No

ServicePath

Service path.

framework

No

Framework

Microservice development framework.

registerBy

No

String

Microservice registration mode.

  • SDK
  • PLATFORM
  • SIDECAR
  • UNKNOWN

modTimestamp

No

String

Latest modification time (UTC).

properties

No

Map<String, String>

Extended attribute. You can customize a key and value.

alias

No

String

Microservice alias. The value contains 1 to 128 characters. Regular expression: ^[a-zA-Z0-9_\-.:]*$.

Table 2 ServicePath parameters

Parameter

Mandatory

Type

Description

Path

No

String

Route address. The value contains 1 to 160 bytes, including digits, letters, and the following characters:.,?'\/+& %$#=~_-@{}.

Property

No

Properties

Extended attribute.

Table 3 Framework parameters

Parameter

Mandatory

Type

Description

name

No

String

Microservice development framework. Default value: UNKNOWN.

version

No

String

Version of the microservice development framework. The value contains 1 to 64 bytes.