QueryClusterDetail - 查询集群详情

接口查询集群详情。

调试

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

调试

授权信息

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

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

请求参数

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

实例ID。

mse-cn-st21ri2****
OrderId string

订单ID。

20576750143****
AclSwitch boolean

是否查询ACL。

false
AcceptLanguage string

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称 类型 描述 示例值
object

字符串对象。

Message string

返回信息。

请求处理成功
RequestId string

请求ID。

9515ACA4-E94D-440D-989E-C379FCED****
Data object

数据概览。

VpcId string

VPC ID。

vpc-bp1hcg467ekqsv0zr****
CreateTime string

集群创建时间。

2020-07-31 11:36:08
IntranetAddress string

私网地址。

192.168.XX.XX
DiskType string

磁盘类型。

alicloud-disk-ssd-multi-zone
PubNetworkFlow string

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

3
DiskCapacity long

磁盘容量,单位:G。

60
MemoryCapacity long

内存大小,单位:G。

2
ClusterAliasName string

集群别名。

mse-7413****
InstanceCount integer

集群实例数。

3
IntranetPort string

私网端口。

8761
InstanceModels array

实例列表。

object

字符串对象。

PodName string

Pod名称。

mse-7413****-159616656****-reg-center-0-0
SingleTunnelVip string

单线程IP。

192.168.XX.XX
InternetIp string

公网IP。

47.98.XX.XX
Ip string

实例IP。

10.12.XX.XX
Role string

角色。

Peer
HealthStatus string

实例健康状态。

Running
CreationTimestamp string

创建时间戳。

1578575377732
Zone string

可用区。

cn-shanghai-f
IntranetDomain string

私网域名。

mse-7413****-eureka.mse.aliyuncs.com
InternetDomain string

公网域名。

mse-7413****-p.eureka.mse.aliyuncs.com
PayInfo string

付费类型,包括包年包月和按量付费类型。

按量付费
InternetAddress string

公网地址。

47.98.XX.XX
InstanceId string

实例ID。

mse-cn-st21ri2****
AclEntryList string

白名单列表。

[]
HealthStatus string

集群健康状态。

RESTART_SUCCESS
InitCostTime long

集群创建耗时,单位:ms。

98408
RegionId string

地域ID。

cn-hangzhou
AclId string

白名单ID。

acl-bp17020kiqvzutwwj****
Cpu integer

CPU数量。

1
ClusterType string

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

Nacos-Ans
ClusterName string

集群名称。

mse-bc1a29b0-160230875****
InitStatus string

集群创建状态。

RESTART_SUCCESS
InternetPort string

私网端口。

8761
AppVersion string

APP版本。

1.2.1
NetType string

网络类型,取值如下:

  • privatenet:表示专有网络。
  • pubnet:表示公网。
privatenet
ClusterVersion string

集群版本。

1.2.1
ClusterSpecification string

引擎规格。

MSE_SC_1_2_200_c
VSwitchId string

交换机ID。

vsw-xxx-xxxx
ConnectionType string

网络连接类型,取值如下:

  • slb
  • eni
slb
MseVersion string

MSE版本号

mse_basic
ChargeType string

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

按量付费
OrderClusterVersion string

原始订单版本号。

1.2.0
Tags object

实例所绑定的标签。

ResourceGroupId string

资源组 ID。

rg-aek2dhgysj*****
ErrorCode string

错误码。

mse-100-000
Success boolean

请求结果,取值如下:

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

示例

正常返回示例

JSON格式

{
  "Message": "请求处理成功",
  "RequestId": "9515ACA4-E94D-440D-989E-C379FCED****",
  "Data": {
    "VpcId": "vpc-bp1hcg467ekqsv0zr****",
    "CreateTime": "2020-07-31 11:36:08",
    "IntranetAddress": "192.168.XX.XX",
    "DiskType": "alicloud-disk-ssd-multi-zone",
    "PubNetworkFlow": "3",
    "DiskCapacity": 60,
    "MemoryCapacity": 2,
    "ClusterAliasName": "mse-7413****",
    "InstanceCount": 3,
    "IntranetPort": "8761",
    "InstanceModels": [
      {
        "PodName": "mse-7413****-159616656****-reg-center-0-0",
        "SingleTunnelVip": "192.168.XX.XX",
        "InternetIp": "47.98.XX.XX",
        "Ip": "10.12.XX.XX",
        "Role": "Peer",
        "HealthStatus": "Running",
        "CreationTimestamp": "1578575377732",
        "Zone": "cn-shanghai-f"
      }
    ],
    "IntranetDomain": "mse-7413****-eureka.mse.aliyuncs.com",
    "InternetDomain": "mse-7413****-p.eureka.mse.aliyuncs.com",
    "PayInfo": "按量付费",
    "InternetAddress": "47.98.XX.XX",
    "InstanceId": "mse-cn-st21ri2****",
    "AclEntryList": "[]",
    "HealthStatus": "RESTART_SUCCESS",
    "InitCostTime": 98408,
    "RegionId": "cn-hangzhou",
    "AclId": "acl-bp17020kiqvzutwwj****",
    "Cpu": 1,
    "ClusterType": "Nacos-Ans",
    "ClusterName": "mse-bc1a29b0-160230875****",
    "InitStatus": "RESTART_SUCCESS",
    "InternetPort": "8761",
    "AppVersion": "1.2.1",
    "NetType": "privatenet",
    "ClusterVersion": "1.2.1",
    "ClusterSpecification": "MSE_SC_1_2_200_c",
    "VSwitchId": "vsw-xxx-xxxx",
    "ConnectionType": "slb",
    "MseVersion": "mse_basic",
    "ChargeType": "按量付费",
    "OrderClusterVersion": "1.2.0",
    "Tags": {
      "test": "test",
      "test2": 1
    },
    "ResourceGroupId": "rg-aek2dhgysj*****"
  },
  "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

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

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