ListListenersByConfig - Microservices Engine - Alibaba Cloud Documentation Center

Queries listeners based on configuration information.

Operation description

Note

The current OpenAPI is not the Nacos-SDK API. For information about the Nacos-SDK API, see Official Documentation.

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 support 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:ListListenersByConfig

get

*Cluster

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

*EngineNamespace

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

None

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	Parameter deprecated, no need to fill in	{\\"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 group.	prod
NamespaceId	string	No	The namespace ID. Default value: public	aaeb4d28-c9eb-4fa2-85f5-d03ce7ee8df1
ExtGrayRules	array	No	Additional canary release rule list, when matching listeners, the additional canary release rules will be merged with existing rules for matching
	object	No	Canary rule item
GrayRuleType	string	No	Canary rule type
GrayRuleName	string	No	The canary version name.
GrayRule	string	No	The canary release rule. For a beta release, you can specify one or more client IP addresses for this parameter. You must separate multiple IP addresses with commas (,). For a tag-based canary release, the value is in the format of Tag name=Tag value. You must separate multiple tag values with commas (,).
GrayRulePriority	integer	No	The canary version priority.
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.
HttpCode	string	HTTP status code.	202
TotalCount	integer	The count.	7
Listeners	array	The information about listeners.
	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
MatchRuleName	string	The name of the canary rule that matches the current listener
MatchRuleType	string	The type of the matched canary rule
RequestId	string	The request ID.	75E1442F-11EC-567A-9CF0-5A36F7904F39
Message	string	The response message.	success
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number to return.	2
ErrorCode	string	The error code.	mse-100-000
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true

Examples

Success response

JSON format

{
  "HttpCode": "202",
  "TotalCount": 7,
  "Listeners": [
    {
      "Ip": "1.1.1.1",
      "Md5": "23sdfdf",
      "Status": "beta",
      "Labels": {
        "key": ""
      },
      "Version": "gray",
      "MatchRuleName": "",
      "MatchRuleType": ""
    }
  ],
  "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
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.