All Products
Search
Document Center

API Gateway:Service

Last Updated:Feb 05, 2026
ParameterTypeDescriptionExample
object

The service object.

serviceIdstring

The service unique ID.

svc-cr6pk4tlhtgm***
sourceTypestring

The source type.

MSE_NACOS
namestring

The service name.

user-service
namespacestring

The namespace of the service.

PUBLIC
addressesarray

The address details, which can be IP addresses or domain names.

string

The domain names or fixed IP addresses.

127.0.0.1:8080
portsarray<object>

The list of objects containing port details.

object

An object containing details about a port.

portinteger

The port number.

8080
namestring

The port name.

user-service
protocolstring

The protocol. Valid values: TCP and UDP.

TCP
unhealthyEndpointsarray

The list of unhealthy endpoints.

string

An unhealthy endpoint.

192.168.1.12:8080
outlierEndpointsarray

The outlier endpoints list

string

string

["10.0.0.2:8080"]
healthCheckServiceHealthCheck

The health check configurations.

healthStatusstring

The health check status.

Valid values:

  • Unhealthy
  • Healthy
Healthy
qualifierstring

The function qualifier name.

LATEST
createTimestamplong

The creation time (unix timestamp).

1725617840096
updateTimestamplong

The last modified time (unix timestamp).

1725868548440
protocolstring

The service protocol type.

HTTP
gatewayIdstring

The gateway instance ID.

gw-xxxx
resourceGroupIdstring

The resource group ID.

rg-xxx
groupNamestring

The service group name.

publich
aiServiceConfigAiServiceConfig

The AI service configurations.

labelDetailsarray

The label details for service version configuration

LabelDetail

LabelDetail

agentServiceConfigAgentServiceConfig

The agent service configuration

expressTypestring

The express type

StartExecution