GetServiceListeners - Query Nacos service listeners | MSE API - Microservices Engine

Queries listeners of a specified Nacos service.

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

mse:GetServiceListeners

get

*Cluster

acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}

*EngineNamespace

acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The data structure.
Data	array<object>	The listener list.
	object	The listener details.
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 namespace ID.	0ba53825-b183-414f-a6a0-288e4f1c467e
ServiceName	string	The name of the monitored service.	zeekr-orderboss
Cluster	string	The cluster of the monitored service.	DEFAULT
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of listeners.	2
PageSize	integer	The number of entries per page.	10
Success	boolean	Indicates whether the request was successful. Valid values: `true` `false`	true
Message	string	The response message. A success message is returned if the request succeeds. An error message is returned if the request fails.	success
RequestId	string	The request ID.	54973C90-F379-4372-9AA5-053A3F7****
ErrorCode	string	The error code returned when the request fails.	mse-100-000
HttpCode	string	The HTTP status code.	202

Examples

Success response

JSON format

{
  "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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.