All Products
Search
Document Center

Microservices Engine:ListListenersByIp

Last Updated:Oct 11, 2024

Queries the information about listeners based on IP addresses.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
mse:ListListenersByIpget
  • Cluster
    acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}
  • EngineNamespace
    acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RequestParsstringNo

The extended request parameters in the JSON format.

{}
InstanceIdstringYes

The ID of the instance.

mse_prepaid_public_cn-i7m2cecji09
IpstringYes

The IP address of the listener.

172.22.0.240
NamespaceIdstringNo

The ID of the namespace.

ea02a522-9482-4255-bb65-dc0636d783f2
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

HttpCodestring

The HTTP status code.

202
TotalCountinteger

The total number of returned instances.

6
Listenersarray<object>

The information about listeners.

Listenerobject

The data structure.

Md5string

The verification string.

23sdfdf
DataIdstring

The ID of the data.

test.yaml
Groupstring

The group.

default
RequestIdstring

The ID of the request.

54973C90-F379-4372-9AA5-053A3F7****
Messagestring

The message returned.

The request was successfully processed.
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The page number of the returned page.

1
ErrorCodestring

The error code returned if the request failed.

MSE-100-000
Successboolean

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": 6,
  "Listeners": [
    {
      "Md5": "23sdfdf",
      "DataId": "test.yaml",
      "Group": "default"
    }
  ],
  "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 codeError codeError messageDescription
400duplicatedClusterAliasNameduplicated cluster alias nameThe instance name is duplicate. User another name.
400illegalRequestillegal request:%sInvalid request: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404clusterNotFoundcluster not foundThe cluster is not found.
500systemErrorsystem errorAn error occurred on the system. Try again later.

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

Change history

Change timeSummary of changesOperation
2023-09-21API Description UpdateView Change Details