首页 微服务引擎MSE API参考指南 API目录 注册配置中心 Nacos服务 ListAnsInstances - 查询Nacos服务实例列表

ListAnsInstances - 查询Nacos服务实例列表

查询Nacos服务实例列表。

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
RequestPars string

扩展请求参数,JSON格式。

{}
PageNum integer

页码。

1
PageSize integer

每页展示实例数。

10
ClusterId string

集群ID。

注意此接口同时有InstanceId与ClusterId,则其中一项必填。
mse-09k1q11****ServiceNamestring是

服务名称。

nameGroupNamestring否

联系人组名称。

testNamespaceIdstring否

命名空间ID。

12233****ClusterNamestring否

集群别名。

mse-7413****InstanceIdstring否

实例ID。

注意此接口同时有InstanceId与ClusterId,则其中一项必填。
mse_prepaid_public_cn-tl327w****AcceptLanguagestring否

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称 类型 描述 示例值
object
HttpCode string

HTTP状态码。

202
TotalCount integer

实例总数。

7
RequestId string

请求ID。

52BA6DA6-A702-4362-A32F-DFF79655****
Message string

信息。

请求处理成功
PageSize integer

每页展示实例数。

10
PageNumber integer

页码。

1
Data array

数据概览。

object
DefaultKey string

缺省键。

30.5.XX.XX:unknown
Ephemeral boolean

临时节点,取值如下:

  • true:获取成功。
  • false:获取失败。
true
Marked boolean

标记,取值如下:

  • true:标记成功。
  • false:标记失败。
true
Ip string

公网IP。

30.5.XX.XX
InstanceId string

实例ID。

30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService
Port integer

端口号

8080
LastBeat long

最近一次的心跳时间。

20201010
OkCount integer

成功计数。

0
Weight integer

权重。

1
InstanceHeartBeatInterval integer

实例心跳间隔,单位:秒。

5000
IpDeleteTimeout integer

IP删除超时。

30000
App string

应用名。

app
FailCount integer

失败计数。

0
Healthy boolean

实例健康状态,取值如下:

  • true:实例健康。
  • false:实例不健康。
true
Enabled boolean

生效状态,取值如下:

  • true:生效。
  • false:不生效。
true
DatumKey string

基准键。

30.5.XX.XX:unknown:DEFAULT
ClusterName string

集群名称。

DEFAULT
InstanceHeartBeatTimeOut integer

实例心跳超时。

15000
ServiceName string

服务名称。

DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::
Metadata object

元数据。

ErrorCode string

错误码。

mse-100-000
Success boolean

请求结果,取值如下:

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

示例

正常返回示例

JSON格式

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Message": "请求处理成功",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "DefaultKey": "30.5.XX.XX:unknown",
      "Ephemeral": true,
      "Marked": true,
      "Ip": "30.5.XX.XX",
      "InstanceId": "30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService",
      "Port": 8080,
      "LastBeat": 20201010,
      "OkCount": 0,
      "Weight": 1,
      "InstanceHeartBeatInterval": 5000,
      "IpDeleteTimeout": 30000,
      "App": "app",
      "FailCount": 0,
      "Healthy": true,
      "Enabled": true,
      "DatumKey": "30.5.XX.XX:unknown:DEFAULT",
      "ClusterName": "DEFAULT",
      "InstanceHeartBeatTimeOut": 15000,
      "ServiceName": "DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::",
      "Metadata": {
        "test": "test",
        "test2": 1
      }
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

错误码

Http code 错误码 错误信息 描述
400 duplicatedClusterAliasName duplicated cluster alias name 实例名称已重复,请换一个
400 illegalRequest illegal request:%s 非法请求:%s
400 invalidParameter parameter error:%s 请求入参异常:%s
403 NoPermission You are not authorized to perform this operation. 没有权限使用此接口
404 clusterNotFound cluster not found 找不到此集群
500 systemError system error 系统开小差了,请稍后重试
500 regcenterError register center error:%s 注册配置中心请求错误:%s

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

阿里云首页 微服务引擎 相关技术圈