GetRegisteredServiceEndpoints - Alibaba Cloud Service Mesh

Retrieves information about registered service endpoints.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicemesh:GetRegisteredServiceEndpoints

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ID of the Service Mesh instance.	c08ba3fd1e6484b0f8cc1ad8fe10d****
Namespace	string	No	The namespace.	default
ClusterIds	string	No	A list of cluster IDs, separated by commas.	c8b054ee8c3914d079b5ce9733328**,c58faedb8a78640d3aeb0372e4c02**
Name	string	No	The service name.	reviews
ServiceType	string	No	The type of the service. Valid values: `ServiceEntry`: a service registered in the Service Mesh instance using a ServiceEntry. `Kubernetes`: a service registered in a data plane Kubernetes cluster.	Kubernetes

Response elements

Element	Type	Description	Example
	object	The response body.
ServiceEndpoints	array<object>	A list of service endpoints.
	object	The information about a service endpoint.
Address	string	The endpoint of the service.	192.168.25.153
ClusterId	string	The ID of the data plane cluster.	c80f45444b3da447da60a911390c2****
EndPointSlice	object	The detailed information about the service endpoints.
ServiceName	string	The service name.	reviews
Namespace	string	The namespace.	default
Location	string	The location of the service. Valid values: `MESH_INTERNAL`: The service is inside the mesh. `MESH_EXTERNAL`: The service is outside the mesh.	MESH_INTERNAL
EndpointsDetails	array<object>	A list of detailed information about the service endpoints.
	object	The detailed information about a service endpoint.
PodName	string	The pod name.	provider-v1-8c86b6898-h***
Address	string	The endpoint of the service.	127.2..
Ports	array	A list of ports.
	integer	The service port.	9090
Hostname	string	The hostname.	www.demo.com
Region	string	The region ID.	cn-hangzhou
SidecarInjected	boolean	Indicates whether a sidecar proxy is injected. Valid values: `true`: A sidecar proxy is injected. `false`: A sidecar proxy is not injected.	false
RequestId	string	The request ID.	31d3a0f0-07ed-4f6e-9004-1804498c****

Examples

Success response

JSON format

{
  "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	Description
500	ERR500	An internal server error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.