全部产品
Search

搜索本产品

    微服务引擎MSE：ListAnsServices - 查询Nacos服务详情

    文档中心

    微服务引擎MSE：ListAnsServices - 查询Nacos服务详情

    更新时间：Nov 20, 2024

    查询Nacos服务详情。

    接口说明

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    ServiceNamestring否

    服务名称。

    		name
    GroupNamestring否

    联系人组名称。

    		name
    NamespaceIdstring否

    命名空间 ID。

    		12233****
    ClusterNamestring否

    查询服务下某个集群的实例列表时所需要的参数。

    		DEFAULT
    HasIpCountstring否

    是否查询服务实例数量。

    枚举值：
    • false：不需要。
    • true：需要。
    		true
    ClusterIddeprecatedstring否

    集群 ID。

    说明 此接口同时有 InstanceId 与 ClusterId，则其中一项必填。
    		mse-09k1q11****
    InstanceIdstring否

    实例 ID。

    说明 此接口同时有 InstanceId 与 ClusterId，则其中一项必填。
    		mse-cn-st21v5****
    PageNuminteger是

    页码。

    		1
    PageSizeinteger是

    每页展示实例数。

    		10
    RegionIdstring否

    地域。

    		cn-hangzhou
    RequestParsstring否

    扩展请求参数，JSON 格式。

    		{}
    AcceptLanguagestring否

    返回信息的语言类型：

    • zh：中文
    • en：英文
    		zh

    返回参数

    名称类型描述示例值
    object

    数据结构。

    HttpCodestring

    HTTP 状态码。

    		202
    TotalCountinteger

    实例总数。

    		7
    RequestIdstring

    请求 ID。

    		52BA6DA6-A702-4362-A32F-DFF79655****
    Messagestring

    信息。

    		请求处理成功
    PageSizeinteger

    每页展示实例数。

    		10
    PageNumberinteger

    页码。

    		1
    Dataarray<object>

    数据概览。

    SimpleNacosAnsServiceobject

    数据结构。

    HealthyInstanceCountinteger

    健康心跳的服务实例总数。

    		1
    GroupNamestring

    联系人组名称。

    		name
    IpCountinteger

    当前服务的实例总数。

    		1
    Namestring

    服务名称。

    		name
    ClusterCountinteger

    集群总数。

    		1
    Sourcestring

    服务类型，取值如下：

    • console：控制台注册。
    • sdk：SDK 注册。
    • governance：服务治理注册。
    		console
    ErrorCodestring

    错误码。

    		mse-100-000
    Successboolean

    请求结果，取值如下：

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

    示例

    正常返回示例

    JSON格式

    {
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Message": "请求处理成功",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "HealthyInstanceCount": 1,
      "GroupName": "name",
      "IpCount": 1,
      "Name": "name",
      "ClusterCount": 1,
      "Source": "console"
    }
  ],
  "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

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

    变更历史

    变更时间变更内容概要操作
    2024-06-27API 内部配置变更，不影响调用查看变更详情