GetRegisteredServiceEndpoints - Alibaba Cloud Service Mesh

Queries the endpoints of a registered service in an Alibaba Cloud Service Mesh (ASM) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The name of the namespace.	c08ba3fd1e6484b0f8cc1ad8fe10d****
Namespace	string	No	The IDs of clusters in the ASM instance. Separate multiple cluster IDs with commas (,).	default
ClusterIds	string	No	The name of the registered service.	c8b054ee8c3914d079b5ce9733328**,c58faedb8a78640d3aeb0372e4c02**
Name	string	No	The type of the registered service. Valid values: `ServiceEntry`: indicates that the service is registered by creating a service entry. `Kubernetes`: indicates that the service is registered on a Kubernetes cluster on the data plane.	reviews
ServiceType	string	No	The endpoints of the registered service.	Kubernetes

Response parameters

Parameter	Type	Description	Example
	object
ServiceEndpoints	object []	The IP address of the registered service.
Address	string	The ID of the cluster on the data plane.	192.168.25.153
ClusterId	string	The details of the endpoints of the registered service.	c80f45444b3da447da60a911390c2****
EndPointSlice	object	The name of the registered service.
ServiceName	string	The name of the namespace.	reviews
Namespace	string	The location of the registered service. Valid values: `MESH_INTERNAL`: The service is deployed inside the ASM instance. `MESH_EXTERNAL`: The service is deployed outside the ASM instance.	default
Location	string	The details of the endpoint of the registered service.	MESH_INTERNAL
EndpointsDetails	object []	The name of the pod.
PodName	string	The IP address of the registered service.	provider-v1-8c86b6898-h***
Address	string	The port of the registered service.	127.2..
Ports	array	The host name of the registered service.
	integer		9090
Hostname	string	The ID of the region in which the registered service resides.	www.demo.com
Region	string	Indicates whether sidecar proxies are injected. Valid values: `true`: yes `false`: no	cn-hangzhou
SidecarInjected	boolean	The ID of the request.	false

Examples

Sample success responses

JSONformat

{
  "ServiceEndpoints": [
    {
      "Address": "192.168.25.153",
      "ClusterId": "c80f45444b3da447da60a911390c2****"
    }
  ],
  "EndPointSlice": {
    "ServiceName": "reviews",
    "Namespace": "default",
    "Location": "MESH_INTERNAL",
    "EndpointsDetails": [
      {
        "PodName": "provider-v1-8c86b6898-h***",
        "Address": "127.2.**.**",
        "Ports": [
          9090
        ],
        "Hostname": "www.demo.com",
        "Region": "cn-hangzhou",
        "SidecarInjected": false
      }
    ]
  },
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****"
}

Error codes

HTTP status code	Error code	Error message
500	ERR500	An internal server error occurred.

For a list of error codes, visit the Service error codes.