ListListenersByIp - Microservices Engine - Alibaba Cloud Documentation Center

Queries the listener list based on an IP address.

Operation description

Note

The current OpenAPI is not a Nacos-SDK API. For more 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 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:ListListenersByIp

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	Extended request parameters in JSON format.	{}
InstanceId	string	Yes	Instance ID.	mse_prepaid_public_cn-i7m2cecji09
Ip	string	Yes	Listener IP address.	172.22.0.240
NamespaceId	string	No	Namespace ID, default is public	ea02a522-9482-4255-bb65-dc0636d783f2
AcceptLanguage	string	No	Language type of the returned information: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object	Data structure.
HttpCode	string	HTTP status code.	202
TotalCount	integer	Total number of instances.	6
Listeners	array	Listener information.
	object	Data structure.
Md5	string	Verification string.	23sdfdf
DataId	string	Data ID.	test.yaml
Group	string	Group.	default
NamespaceId	string	Namespace ID
RequestId	string	Request ID.	54973C90-F379-4372-9AA5-053A3F7****
Message	string	Response message.	The request was successfully processed.
PageSize	integer	Size of the current page.	10
PageNumber	integer	Current page number.	1
ErrorCode	string	Error code.	MSE-100-000
Success	boolean	Request result, with the following values: `true`: The request is successful. `false`: The request failed.	True

Examples

Success response

JSON format

{
  "HttpCode": "202",
  "TotalCount": 6,
  "Listeners": [
    {
      "Md5": "23sdfdf",
      "DataId": "test.yaml",
      "Group": "default",
      "NamespaceId": ""
    }
  ],
  "RequestId": "54973C90-F379-4372-9AA5-053A3F7****",
  "Message": "The request was successfully processed.\n",
  "PageSize": 10,
  "PageNumber": 1,
  "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.