文档

ListListenersByIp - 根据IP查询监听者列表

更新时间:

根据IP查询监听者列表。

接口说明

说明 当前的 OpenAPI 并非是 Nacos-SDK API,Nacos-SDK API 相关内容,请参见官方文档

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:ListListenersByIp
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RequestParsstring

扩展请求参数,JSON 格式。

{}
InstanceIdstring

实例 ID。

mse_prepaid_public_cn-i7m2cecji09
Ipstring

监听 IP 地址。

172.22.0.240
NamespaceIdstring

命名空间 ID。

ea02a522-9482-4255-bb65-dc0636d783f2
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

数据结构。

HttpCodestring

HTTP 状态码。

202
TotalCountinteger

实例总数。

6
Listenersarray<object>

监听信息。

object

数据结构。

Md5string

校验串。

23sdfdf
DataIdstring

数据 ID。

test.yaml
Groupstring

分组。

default
RequestIdstring

请求 ID。

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

响应信息。

请求处理成功
PageSizeinteger

当前页的大小。

10
PageNumberinteger

当前页码。

1
ErrorCodestring

错误码。

MSE-100-000
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true

示例

正常返回示例

JSON格式

{
  "HttpCode": "202",
  "TotalCount": 6,
  "Listeners": [
    {
      "Md5": "23sdfdf",
      "DataId": "test.yaml",
      "Group": "default",
      "NamespaceId": ""
    }
  ],
  "RequestId": "54973C90-F379-4372-9AA5-053A3F7****",
  "Message": "请求处理成功",
  "PageSize": 10,
  "PageNumber": 1,
  "ErrorCode": "MSE-100-000",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-21OpenAPI 描述信息更新查看变更详情