All Products
Search
Document Center

API Gateway:Service

Last Updated:Mar 30, 2026

Parameter

Type

Description

Example

object

The service.

serviceId

string

The unique service ID.

svc-cr6pk4tlhtgm***

sourceType

string

The service source type.

MSE_NACOS

name

string

The service name.

user-service

namespace

string

The service namespace.

PUBLIC

healthCheck

ServiceHealthCheck

The health check configuration.

healthStatus

string

The health status of the service. Valid values: Healthy and Unhealthy.

Healthy

qualifier

string

The function qualifier.

LATEST

createTimestamp

integer

The creation timestamp.

1725617840096

updateTimestamp

integer

The last update timestamp.

1725868548440

protocol

string

The service protocol.

HTTP

gatewayId

string

The gateway instance ID.

gw-xxxx

resourceGroupId

string

The resource group ID.

rg-xxx

groupName

string

The service group name.

publich

aiServiceConfig AiServiceConfig

The AI service configuration.

agentServiceConfig AgentServiceConfig

The agent service configuration.

expressType

string

The execution mode for CloudFlow.

StartExecution

addresses

array

A list of service addresses, such as IP addresses or domain names.

string

A domain name or an IP address.

127.0.0.1:8080

ports

array

A list of service ports.

object

A service port.

port

integer

The port number.

8080

name

string

The port name.

user-service

protocol

string

The protocol. Valid values: TCP and UDP.

TCP

unhealthyEndpoints

array

A list of unhealthy endpoints.

string

An unhealthy endpoint.

192.168.1.12:8080

outlierEndpoints

array

A list of endpoints removed by circuit breaking.

string

An endpoint removed by circuit breaking.

["10.0.0.2:8080"]

labelDetails

array

The service label details.

LabelDetail

A label detail.

versions

array

A list of service versions.

object

A service version.

name

string

The version name.

labels

array

The labels of the version.

object

A label, represented as a key-value pair.

key

string

The key of the label.

value

string

The value of the label.