全部产品
Search

搜索本产品

    微服务引擎MSE：ListAnsServiceClusters - 查询集群服务详情

    文档中心

    微服务引擎MSE：ListAnsServiceClusters - 查询集群服务详情

    更新时间：Nov 13, 2024

    查询Nacos服务的集群列表。

    接口说明

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    PageNuminteger是

    页码。

    		1
    PageSizeinteger是

    每页展示实例数。

    		10
    ClusterIddeprecatedstring否

    MSE 集群 ID。

    说明 此处的集群与 nacos 服务下的集群概念不同，勿混淆。
    		mse-09k1q110q01
    ServiceNamestring否

    服务名称。

    		nacos.test.3
    GroupNamestring否

    分组名称。

    		DEFAULT_GROUP
    NamespaceIdstring否

    命名空间 ID。

    		12233****
    ClusterNamestring否

    集群别名。

    		mse-7413****
    InstanceIdstring否

    实例 ID。

    		mse_prepaid_public_cn-tl32a6****
    AcceptLanguagestring否

    返回信息的语言类型：

    • zh：中文
    • en：英文
    		zh

    返回参数

    名称类型描述示例值
    object

    数据结构。

    Messagestring

    信息。

    		请求处理成功
    RequestIdstring

    请求 ID。

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

    数据概览。

    ProtectThresholdfloat

    保护阈值。

    		0
    GroupNamestring

    服务所属服务组。

    		DEFAULT_GROUP
    Clustersarray<object>

    集群信息。

    NacosAnsClusterobject

    数据结构。

    DefaultCheckPortinteger

    默认检查端口。

    		80
    HealthCheckerTypestring

    健康检查类型。

    		connection：链接存活检查 tcp: TCP连接检查 http：HTTP连接检查
    UseIPPort4Checkboolean

    服务端是否主动发起端到端健康状态检查，当服务为非临时服务时此值有效。

    		true
    ServiceNamestring

    全量服务名。

    		DEFAULT_GROUP@@nacos.test.3
    Namestring

    集群名称。

    		test
    DefaultPortinteger

    默认端口。

    		80
    Metadataobject

    集群元数据。

    		111
    Namestring

    服务名称。

    		nacos.test.3
    SelectorTypestring

    选举模式。

    		none
    Metadataobject

    服务元数据。

    		111
    Ephemeralboolean

    是否临时节点，取值如下：

    • true：是。
    • false：否。
    		true
    Sourcestring

    服务类型，取值如下：

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

    服务类型为服务治理注册时，服务所关联的服务治理应用信息。

    AppIdstring

    服务治理应用 id。

    		hkhon1po62@904cba2c0xxxxxx
    AppNamestring

    服务治理应用名。

    		spring-cloud-b
    Portinteger

    服务治理应用端口。

    		6001
    CheckTypestring

    健康检查协议，取值如下：

    • connection：链接存活检查。
    • tcp: TCP 连接检查。
    • http：HTTP 连接检查。
    		connection
    CheckPathstring

    健康检查路径（健康检查类型为 http 时携带）。

    		/health
    CheckTimeoutinteger

    健康检查响应超时时间，单位：秒。

    		5
    CheckInternalinteger

    健康检查间隔，单位：秒。

    		2
    HealthyCheckTimesinteger

    健康检查健康阈值，指实例从不健康变为健康过程中健康探测重试次数。

    		2
    UnhealthyCheckTimesinteger

    健康检查不健康阈值，指实例从健康变为不健康过程中健康探测重试次数。

    		2
    ErrorCodestring

    错误码。

    		mse-100-000
    Successboolean

    请求结果，取值如下：

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

    HTTP 状态码。

    		200

    示例

    正常返回示例

    JSON格式

    {
  "Message": "请求处理成功",
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Data": {
    "ProtectThreshold": 0,
    "GroupName": "DEFAULT_GROUP",
    "Clusters": [
      {
        "DefaultCheckPort": 80,
        "HealthCheckerType": "connection：链接存活检查\ntcp: TCP连接检查\nhttp：HTTP连接检查",
        "UseIPPort4Check": true,
        "ServiceName": "DEFAULT_GROUP@@nacos.test.3",
        "Name": "test",
        "DefaultPort": 80,
        "Metadata": 111
      }
    ],
    "Name": "nacos.test.3",
    "SelectorType": "none",
    "Metadata": 111,
    "Ephemeral": true,
    "Source": "console",
    "AppDetail": {
      "AppId": "hkhon1po62@904cba2c0xxxxxx",
      "AppName": "spring-cloud-b",
      "Port": 6001,
      "CheckType": "connection",
      "CheckPath": "/health",
      "CheckTimeout": 5,
      "CheckInternal": 2,
      "HealthyCheckTimes": 2,
      "UnhealthyCheckTimes": 2
    }
  },
  "ErrorCode": "mse-100-000",
  "Success": true,
  "HttpCode": "200"
}

    错误码

    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-06-14OpenAPI 返回结构发生变更查看变更详情
    2023-05-17OpenAPI 错误码发生变更查看变更详情
    2023-05-08OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情