AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 微服务引擎 开发参考 API参考（mse） API参考指南 API目录 注册配置中心 集群管理 QueryClusterInfo - 查询集群静态信息

QueryClusterInfo - 查询集群静态信息

更新时间：
产品详情
我的收藏

查询集群的静态信息。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mse:QueryClusterInfo

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
ClusterId

string

否

集群 ID。

mse-09k1q11****
InstanceId

string

否

实例 ID。

mse_prepaid_public_cn-7mz2t63ci03
OrderId

string

否

订单 ID。

20574710974****
AclSwitch

boolean

否

是否查询公网白名单配置。

false
RegionId

string

否

地域 ID。

cn-hangzhou
RequestPars

string

否

扩展请求参数，JSON 格式。

{}
AcceptLanguage

string

否

返回信息的语言类型：

  • zh：中文

  • en：英文

zh

返回参数

名称

类型

描述

示例值

object

数据结构。

Message

string

返回信息。

  • 当请求成功时，返回成功信息。

  • 当请求失败时，返回失败原因。

请求处理成功
RequestId

string

请求 ID。

415088B3-A7BE-56F6-9CD9-C42DE895CD41
Data

object

数据概览。

VpcId

string

集群所处的 VPC ID。

vpc-bp1v5nbauzh8xxxxxxx
CreateTime

string

集群创建时间。

2022-12-15 10:02:07
IntranetAddress

string

预留字段。

null
DiskType

string

废弃字段。

null
PubNetworkFlow

string

公网带宽，单位：Mbps。
取值范围：0~5000，其中 0 表示不接入公网。

1
DiskCapacity

integer

废弃字段。

null
MemoryCapacity

integer

废弃字段。

null
ClusterAliasName

string

集群别名。

开发环境
InstanceCount

integer

集群实例数。

3
IntranetPort

string

集群内网开放的端口。

8848,6443,9848,8761
InstanceModels

array

预留结构。

object

预留结构。

PodName

string

预留字段。

null
SingleTunnelVip

string

预留字段。

null
InternetIp

string

预留字段。

null
Ip

string

预留字段。

null
Role

string

预留字段。

null
HealthStatus

string

预留字段。

null
CreationTimestamp

string

预留字段。

null
Zone

string

预留字段。

null
IntranetDomain

string

内网域名。

mse-xxxxx-nacos-ans.mse.aliyuncs.com
InternetDomain

string

公网域名。

mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com
PayInfo

string

付费方式。

按量付费
InternetAddress

string

预留字段。

null
InstanceId

string

实例 ID。

mse-cn-st21ri2****
AclEntryList

string

公网白名单。

["127.0.0.0/32"]
HealthStatus

string

集群状态。

INIT_SUCCESS
InitCostTime

integer

集群初始化所用的时间（毫秒）。

53353
RegionId

string

地域 ID。

cn-hangzhou
AclId

string

公网白名单实例 ID

acl-bp144q24cgqvzckmxxxx
Cpu

integer

废弃字段。

null
ClusterType

string

集群类型，包括 ZooKeeper、Nacos-Ans 和 Eureka。

Nacos-Ans
ClusterName

string

集群完整名称。

mse-74355150-xxxxxxx
InitStatus

string

初始化状态。

INIT_SUCCESS
InternetPort

string

公网集群开放端口。

8848,6443,9848,8761
AppVersion

string

集群版本号。

2.1.0
NetType

string

集群网络连接类型。

privatenet
ClusterVersion

string

订单版本。

NACOS_2_0_0
ClusterSpecification

string

引擎规格。

MSE_SC_2_4_60_c
VSwitchId

string

交换机 ID。

vsw-bp1egfakxxxxx
ConnectionType

string

废弃字段。

null
MseVersion

string

集群版本。

mse_pro
ChargeType

string

付费模式，包括包年包月和按量付费。

POSTPAY
Tags

object

标签。

ExpectZones

array

当前集群可打散到的可用区列表。

string

可用区 ID。

cn-hangzhou-k
MaintenancePeriod

object

运维时间窗口

EndTime

string

运维时间窗口开始时间

02:00
StartTime

string

运维时间窗口结束时间

06:00
EndDate

string

到期时间（包年包月）

2021-08-01 00:00:00
SecurityGroupId

string

ENI 网络接入的安全组 ID

sg-uf6hgwe067prhg68agfa
SecurityGroupType

string

ENI 网络接入的安全组类型

enterprise
EipInstanceId

string

弹性公网 IP（EIP）的实例 ID

eip-bp1uujshd5funmyy8rcl9
CanUpdate

boolean

集群是否有小版本可以升级

true
VersionCode

string

集群当前版本 Code

NACOS_2_1_0_1
VersionLifecycle

string

ErrorCode

string

错误码。

mse-100-000
Success

boolean

请求结果，取值如下：

  • true：请求成功。

  • false：请求失败。

true

示例

正常返回示例

JSON格式

{
  "Message": "请求处理成功",
  "RequestId": "415088B3-A7BE-56F6-9CD9-C42DE895CD41",
  "Data": {
    "VpcId": "vpc-bp1v5nbauzh8xxxxxxx",
    "CreateTime": "2022-12-15 10:02:07",
    "IntranetAddress": "null",
    "DiskType": "null",
    "PubNetworkFlow": "1",
    "DiskCapacity": 0,
    "MemoryCapacity": 0,
    "ClusterAliasName": "开发环境",
    "InstanceCount": 3,
    "IntranetPort": "8848,6443,9848,8761",
    "InstanceModels": [
      {
        "PodName": "null",
        "SingleTunnelVip": "null",
        "InternetIp": "null",
        "Ip": "null",
        "Role": "null",
        "HealthStatus": "null",
        "CreationTimestamp": "null",
        "Zone": "null"
      }
    ],
    "IntranetDomain": "mse-xxxxx-nacos-ans.mse.aliyuncs.com",
    "InternetDomain": "mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com",
    "PayInfo": "按量付费",
    "InternetAddress": "null",
    "InstanceId": "mse-cn-st21ri2****",
    "AclEntryList": "[\"127.0.0.0/32\"]",
    "HealthStatus": "INIT_SUCCESS",
    "InitCostTime": 53353,
    "RegionId": "cn-hangzhou",
    "AclId": "acl-bp144q24cgqvzckmxxxx",
    "Cpu": 0,
    "ClusterType": "Nacos-Ans",
    "ClusterName": "mse-74355150-xxxxxxx",
    "InitStatus": "INIT_SUCCESS",
    "InternetPort": "8848,6443,9848,8761",
    "AppVersion": "2.1.0",
    "NetType": "privatenet",
    "ClusterVersion": "NACOS_2_0_0",
    "ClusterSpecification": "MSE_SC_2_4_60_c",
    "VSwitchId": "vsw-bp1egfakxxxxx",
    "ConnectionType": "null",
    "MseVersion": "mse_pro",
    "ChargeType": "POSTPAY",
    "Tags": {
      "test": "test",
      "test2": 1
    },
    "ExpectZones": [
      "cn-hangzhou-k"
    ],
    "MaintenancePeriod": {
      "EndTime": "02:00",
      "StartTime": "06:00"
    },
    "EndDate": "2021-08-01 00:00:00",
    "SecurityGroupId": "sg-uf6hgwe067prhg68agfa",
    "SecurityGroupType": "enterprise",
    "EipInstanceId": "eip-bp1uujshd5funmyy8rcl9",
    "CanUpdate": true,
    "VersionCode": "NACOS_2_1_0_1",
    "VersionLifecycle": ""
  },
  "ErrorCode": "mse-100-000",
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述
400 IllegalRequest Invalid request:%s 非法请求： %s
400 InvalidParameter Parameter error:%s 请求参数错误：%s
500 InternalError Console error. Try again later:%s 控制台错误.稍后重试：%s
403 NoPermission You are not authorized to perform this operation:%s 没有权限使用此接口：%s
404 NotFound Not found:%s 资源不存在：%s

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

变更历史

更多信息，参考变更详情。

上一篇：QueryInstancesInfo - 查询集群静态信息下一篇：QueryClusterDetail - 查询集群详情