GetRegisteredServiceEndpoints - Alibaba Cloud Service Mesh

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
servicemesh:GetRegisteredServiceEndpoints	get	All Resources ``	none	none

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	array<object>	The IP address of the registered service.
ServiceEndpoint	object
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	array<object>	The name of the pod.
endpointsDetail	object
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.
port	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.