All Products
Search
Document Center

API Gateway:Service

Last Updated:Dec 17, 2025
ParameterTypeDescriptionExample
object

The service object.

serviceIdstring

The service ID.

svc-cr6pk4tlhtgm***
sourceTypestring

The source type.

MSE_NACOS
namestring

The service name.

user-service
namespacestring

The namespace.

PUBLIC
addressesarray

The address information, which may be IP addresses or domain names.

string

The domain names or fixed IP addresses.

127.0.0.1:8080
portsarray<object>

The information about the ports.

object

The information about the port.

portinteger

The port number.

8080
namestring

The port name.

user-service
protocolstring

The protocol. Valid values: TCP and UDP.

TCP
unhealthyEndpointsarray

The unhealthy endpoints.

string

The unhealthy endpoint.

192.168.1.12:8080
healthCheckServiceHealthCheck

The health check configurations.

healthStatusstring

The health check status.

Valid values:

  • Unhealthy
  • Healthy
Healthy
qualifierstring

The function qualified name.

LATEST
createTimestamplong

The creation timestamp.

1725617840096
updateTimestamplong

The update timestamp.

1725868548440
protocolstring

The service protocol.

HTTP
gatewayIdstring

The instance ID.

gw-xxxx
resourceGroupIdstring

The resource group ID.

rg-xxx
groupNamestring

The service group name.

publich
aiServiceConfigAiServiceConfig

The AI service configurations.