ListListenersByConfig - Microservices Engine - Alibaba Cloud Documentation Center

Queries listeners based on configuration information.

Operation description

Note The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the official documentation.

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:ListListenersByConfig	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
RequestPars	string	No	The extended request parameters in the JSON format.	{\\"appGroup\\":\\"emas-zfive_prehost\\",\\"appName\\":\\"emas-zfive\\",\\"appStage\\":\\"PRE_PUBLISH\\",\\"appUnit\\":\\"\\",\\"bucId\\":\\"225902\\",\\"bucName\\":\\"Wireless\\",\\"provider\\":\\"aliyun\\"}
InstanceId	string	Yes	The ID of the instance.	mse-cn-m7r1yurp00e
DataId	string	Yes	The ID of the data.	zeekr-clueboss.yml
Group	string	Yes	The name of the group.	prod
NamespaceId	string	No	The ID of the namespace.	aaeb4d28-c9eb-4fa2-85f5-d03ce7ee8df1
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpCode	string	The HTTP status code returned.	202
TotalCount	integer	The total number of entries returned.	7
Listeners	array<object>	The information about listeners.
Listener	object	The data structure.
Ip	string	The IP address.	1.1.1.1
Md5	string	The verification string.	23sdfdf
Status	string	The status.	beta
Labels	object	The label of the listener.
	string	The key-value pairs of the label.
Version	string	The current version of the listener. Valid values: gray and normal.	gray
RequestId	string	The ID of the request.	75E1442F-11EC-567A-9CF0-5A36F7904F39
Message	string	The message returned.	success
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number of the returned page.	2
ErrorCode	string	The error code returned if the request failed.	mse-100-000
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "HttpCode": "202",
  "TotalCount": 7,
  "Listeners": [
    {
      "Ip": "1.1.1.1",
      "Md5": "23sdfdf",
      "Status": "beta",
      "Labels": {
        "key": ""
      },
      "Version": "gray"
    }
  ],
  "RequestId": "75E1442F-11EC-567A-9CF0-5A36F7904F39",
  "Message": "success",
  "PageSize": 10,
  "PageNumber": 2,
  "ErrorCode": "mse-100-000",
  "Success": true
}

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
2024-11-06	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2022-03-16	The response structure of the API has changed	View Change Details