MicroService

Description

API


    POST /api/microservice
    PUT /api/microservice/<key>
    DELETE /api/microservice/<key>
    GET /api/microservice
    GET /api/microservice/<key>

CLI


    configure microservice <key>
    show microservice <key>

Data

MicroService

uuid

Type: string
Category: required
Description

name

Type: string
Category: required
Description

orchestrator_name

Type: string
Category: required
Description

application_name

Type: string
Category: required
Description

ip_list

Type: bool
Category: optional
Description: Flag to indicate if container IP list is provided by cloud connectorThis is applicable for overlay cases.

containers

Type: MicroServiceContainer
Category: repeated
Description: The list of containers for this microservice

created_by

Type: string
Category: optional
Description: Creator name

description

Type: string
Category: optional
Description

tenant_ref

Type: Reference to Tenant
Category: required
Description

MicroServiceContainer

Type: IpAddr
Category: required
Description: IP Address of the container.

port

Type: uint32
Category: optional
Description: Port nunber of the instance

container_id

Type: string
Category: optional
Description: ID of the container.

host

Type: string
Category: optional
Description: ID or name of the host where the container is.

task_id

Type: string
Category: optional
Description: Marathon Task ID of the instance

IpAddr

addr

Type: string
Category: required
Description: IP address

type

Type: enum
Category: required
Description
Choices: V4, DNS

References

Tenant

Sub Objects

MicroServiceDetail

API


    GET /api/microservice/<key>/runtime/detail/<key>
	Query Params: SeParamsFilter

CLI


    show microservice <key> detail filter [primary_only] [disable_aggregate] [se_uuid] [all_se]

Data

MicroServiceDetail

uuid

Type: string
Category: optional
Description

name

Type: string
Category: optional
Description

application_name

Type: string
Category: optional
Description

orchestrator_name

Type: string
Category: optional
Description

containers

Type: ContainerDetail
Category: repeated
Description

se_uuid

Type: string
Category: optional
Description

ContainerDetail

Type: string
Category: optional
Description

ip_addr

Type: string
Category: optional
Description

host

Type: string
Category: optional
Description

name

Type: string
Category: optional
Description

nat_ip_addr

Type: string
Category: optional
Description

MicroServiceInternal

API


    GET /api/microservice/<key>/runtime/internal/<key>
	Query Params: SeParamsFilter

CLI


    show microservice <key> internal filter [primary_only] [disable_aggregate] [se_uuid] [all_se]

Data

MicroServiceInternal

uuid

Type: string
Category: optional
Description

name

Type: string
Category: optional
Description

app_name

Type: string
Category: optional
Description

orchestrator_name

Type: string
Category: optional
Description

containers

Type: ContainerInternal
Category: repeated
Description

se_uuid

Type: string
Category: optional
Description

ip_list

Type: bool
Category: optional
Description

ContainerInternal

Type: string
Category: optional
Description

task_id

Type: string
Category: optional
Description

ip_addr

Type: string
Category: optional
Description

host

Type: string
Category: optional
Description

ports

Type: string
Category: optional
Description

name

Type: string
Category: optional
Description

nat_ip_addr

Type: string
Category: optional
Description

Filters

SeParamsFilter

primary_only

Type: bool
Category: optional
Description: Only from primary se

disable_aggregate

Type: enum
Category: optional
Description: Do not aggregate at SE or CORE level
Choices: SE, CORE

se_uuid

Type: string
Category: optional
Description: Only from this se

all_se

Type: bool
Category: optional
Description: Report from all SEs overriding disable_aggregate field. If there are more than max scale out SEs, then this filter pops an error message to use a specific SE
Default: False