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

QueryClusterInfo - 查询集群静态信息

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

查询集群的静态信息。

调试

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

授权信息

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

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

请求参数

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

集群 ID。

mse-09k1q11****
InstanceIdstring否

实例 ID。

mse_prepaid_public_cn-7mz2t63ci03
OrderIdstring否

订单 ID。

20574710974****
AclSwitchboolean否

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

false
RegionIdstring否

地域 ID。

cn-hangzhou
RequestParsstring否

扩展请求参数，JSON 格式。

{}
AcceptLanguagestring否

返回信息的语言类型：

  • zh：中文
  • en：英文
zh

返回参数

名称类型描述示例值
object

数据结构。

Messagestring

返回信息。

  • 当请求成功时，返回成功信息。
  • 当请求失败时，返回失败原因。
请求处理成功
RequestIdstring

请求 ID。

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

数据概览。

VpcIdstring

集群所处的 VPC ID。

vpc-bp1v5nbauzh8xxxxxxx
CreateTimestring

集群创建时间。

2022-12-15 10:02:07
IntranetAddressstring

预留字段。

null
DiskTypestring

废弃字段。

null
PubNetworkFlowstring

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

1
DiskCapacitylong

废弃字段。

null
MemoryCapacitylong

废弃字段。

null
ClusterAliasNamestring

集群别名。

开发环境
InstanceCountinteger

集群实例数。

3
IntranetPortstring

集群内网开放的端口。

8848,6443,9848,8761
InstanceModelsarray<object>

预留结构。

InstanceModelobject

预留结构。

PodNamestring

预留字段。

null
SingleTunnelVipstring

预留字段。

null
InternetIpstring

预留字段。

null
Ipstring

预留字段。

null
Rolestring

预留字段。

null
HealthStatusstring

预留字段。

null
CreationTimestampstring

预留字段。

null
Zonestring

预留字段。

null
IntranetDomainstring

内网域名。

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

公网域名。

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

付费方式。

按量付费
InternetAddressstring

预留字段。

null
InstanceIdstring

实例 ID。

mse-cn-st21ri2****
AclEntryListstring

公网白名单。

["127.0.0.0/32"]
HealthStatusstring

集群状态。

INIT_SUCCESS
InitCostTimelong

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

53353
RegionIdstring

地域 ID。

cn-hangzhou
AclIdstring

公网白名单实例 ID

acl-bp144q24cgqvzckmxxxx
Cpuinteger

废弃字段。

null
ClusterTypestring

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

Nacos-Ans
ClusterNamestring

集群完整名称。

mse-74355150-xxxxxxx
InitStatusstring

初始化状态。

INIT_SUCCESS
InternetPortstring

公网集群开放端口。

8848,6443,9848,8761
AppVersionstring

集群版本号。

2.1.0
NetTypestring

集群网络连接类型。

privatenet
ClusterVersionstring

订单版本。

NACOS_2_0_0
ClusterSpecificationstring

引擎规格。

MSE_SC_2_4_60_c
VSwitchIdstring

交换机 ID。

vsw-bp1egfakxxxxx
ConnectionTypestring

废弃字段。

null
MseVersionstring

集群版本。

mse_pro
ChargeTypestring

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

POSTPAY
Tagsobject

标签。

ExpectZonesarray

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

ExpectZonestring

可用区 ID。

cn-hangzhou-k
MaintenancePeriodobject

运维时间窗口

EndTimestring

运维时间窗口开始时间

02:00
StartTimestring

运维时间窗口结束时间

06:00
EndDatestring

到期时间（包年包月）

2021-08-01 00:00:00
SecurityGroupIdstring

ENI 网络接入的安全组 ID

sg-uf6hgwe067prhg68agfa
SecurityGroupTypestring

ENI 网络接入的安全组类型

enterprise
EipInstanceIdstring

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

eip-bp1uujshd5funmyy8rcl9
CanUpdateboolean

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

true
VersionCodestring

集群当前版本 Code

NACOS_2_1_0_1
ErrorCodestring

错误码。

mse-100-000
Successboolean

请求结果，取值如下：

  • 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"
  },
  "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-12-20OpenAPI 返回结构发生变更查看变更详情
2023-10-11OpenAPI 返回结构发生变更查看变更详情
2023-08-29OpenAPI 返回结构发生变更查看变更详情
2023-07-03OpenAPI 返回结构发生变更查看变更详情
2023-04-25API 内部配置变更，不影响调用查看变更详情
上一篇：QueryInstancesInfo - 查询集群静态信息下一篇：QueryClusterDetail - 查询集群详情
文档推荐