GetServiceListeners - Microservices Engine - Alibaba Cloud Documentation Center

Queries the list of listeners for the destination service.

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
mse:GetServiceListeners	get	Cluster `acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}` EngineNamespace `acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ServiceName	string	Yes	The name of the service whose listeners you want to query.	zeekr-orderboss
GroupName	string	Yes	The group to which the service belongs.	WEB_GROUP
NamespaceId	string	Yes	The namespace to which the service belongs.	ddaf8f12-****-b1c1-86e7c72e266b
ClusterName	string	No	The name of the cluster to which the service belongs. Note The cluster is a concept for Nacos services and is not equivalent to a Microservices Engine (MSE) instance.	DEFAULT
HasIpCount	string	No	A reserved parameter.	none
ClusterId`deprecated`	string	No	The ID of the MSE instance to which the service belongs. Note You must specify InstanceId or ClusterId.	mse-09k1q11****
InstanceId	string	No	The ID of the instance to which the service belongs. Note You must specify InstanceId or ClusterId.	mse_prepaid_public_cn-tl32odtt20j
PageNum	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	10
RegionId	string	No	The ID of the region.	cn-hangzhou
RequestPars	string	No	The extended request parameters in the JSON format.	{}
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The data structure.
Data	array<object>	The returned data.
data	object	The details of the data.
Addr	string	The IP address of the listener.	119.23.84.102
Agent	string	The listener client version.	Nacos-Java-Client:v2.1.1
App	string	The application name of the listener.	app
IP	string	The IP address of the monitored service.	172.16.1.5
Port	string	The port number of the monitored service.	8080
NamespaceId	string	The ID of the namespace.	0ba53825-b183-414f-a6a0-288e4f1c467e
ServiceName	string	The name of the monitored service.	zeekr-orderboss
Cluster	string	The name of the cluster to which the monitored service belongs.	DEFAULT
PageNumber	integer	The page number of the returned page.	1
TotalCount	integer	The number of listeners that are queried.	2
PageSize	integer	The number of entries returned per page.	10
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Message	string	The message returned. If the request is successful, a success message is returned. If the request fails, an error message is returned.	success
RequestId	string	The ID of the request.	54973C90-F379-4372-9AA5-053A3F7****
ErrorCode	string	The error code returned if the request failed.	mse-100-000
HttpCode	string	The HTTP status code returned.	202

Examples

Sample success responses

JSONformat

{
  "Data": [
    {
      "Addr": "119.23.84.102",
      "Agent": "Nacos-Java-Client:v2.1.1",
      "App": "app",
      "IP": "172.16.1.5",
      "Port": "8080",
      "NamespaceId": "0ba53825-b183-414f-a6a0-288e4f1c467e",
      "ServiceName": "zeekr-orderboss",
      "Cluster": "DEFAULT"
    }
  ],
  "PageNumber": 1,
  "TotalCount": 2,
  "PageSize": 10,
  "Success": true,
  "Message": "success",
  "RequestId": "54973C90-F379-4372-9AA5-053A3F7****",
  "ErrorCode": "mse-100-000",
  "HttpCode": "202"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

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

Change history

Change time	Summary of changes	Operation
2023-04-25	The internal configuration of the API is changed, but the call is not affected	View Change Details