MicroService

serviceId

String

No

Microservice ID, which must be unique.

The value must be 1 to 64 characters long.

Regular expression: ^.*$

environment

String

No

Service stage. Value: development, testing, acceptance, or production.

Schemas can be added or modified only when this parameter is set to development, testing, or acceptance.

Default value: development.

appId

String

Yes

Application ID, which must be unique.

The value must be 1 to 160 characters long.

Regular expression: ^[a-zA-Z0-9]*$|^[a-zA-Z0-9][a-zA-Z0-9_\-.]*[a-zA-Z0-9]$

serviceName

String

Yes

Microservice name, which must be unique in an application.

The value must be 1 to 128 characters long.

Regular expression: ^[a-zA-Z0-9]*$|^[a-zA-Z0-9][a-zA-Z0-9_\-.]*[a-zA-Z0-9]$

version

String

Yes

Microservice version.

The value must be 1 to 64 characters long.

Regular expression: ^[0-9]*$|^[0-9]+(\.[0-9]+)*$

description

String

No

Microservice description.

The value contains a maximum of 256 characters.

level

String

No

Microservice level. Options:

• FRONT
• MIDDLE
• BACK

timestamp

String

No

Microservice registration time.

schemas

String

No

Microservice schema content. The value must be 1 to 160 bytes long. Only digits, letters, underscores (_), hyphens (-), and periods (.) are allowed. An array contains a maximum of 100 schemas.

status

String

No

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

paths

ServicePath

No

Service path.

framework

Framework

No

Microservice development framework.

registerBy

String

No

Microservice registration mode. Options:

• SDK
• PLATFORM
• SIDECAR
• UNKNOWN

modTimestamp

String

No

Latest modification time (UTC).

properties

Map<String, String>

No

Extended attribute. You can customize a key and value.

alias

String

No

Microservice alias. The value contains 1 to 128 characters.

Regular expression: ^[a-zA-Z0-9_\-.:]*$

Path

String

No

Route address. The value must be 1 to 160 bytes long. Only digits, letters, and special characters (.,?'\/+&%$#=~_-@{}) are allowed.

Property

Properties

No

Extended attribute.

name

String

No

Microservice development framework. Default value: UNKNOWN.

version

String

No

Version of the microservice development framework. The value must be 1 to 64 bytes long.