文档

QueryClusterDetail - 查询集群详情

更新时间:

接口查询集群详情。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

mse-cn-st21ri2****
OrderIdstring

订单 ID。

20576750143****
AclSwitchboolean

是否查询 ACL。

false
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

字符串对象。

Messagestring

返回信息。

请求处理成功
RequestIdstring

请求 ID。

9515ACA4-E94D-440D-989E-C379FCED****
Dataobject

数据概览。

VpcIdstring

VPC ID。

vpc-bp1hcg467ekqsv0zr****
CreateTimestring

集群创建时间。

2020-07-31 11:36:08
IntranetAddressstring

私网地址。

192.168.XX.XX
DiskTypestring

磁盘类型。

alicloud-disk-ssd-multi-zone
PubNetworkFlowstring

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

3
DiskCapacitylong

磁盘容量,单位:G。

60
MemoryCapacitylong

内存大小,单位:G。

2
ClusterAliasNamestring

集群别名。

mse-7413****
InstanceCountinteger

集群实例数。

3
IntranetPortstring

私网端口。

8761
InstanceModelsarray<object>

实例列表。

object

字符串对象。

PodNamestring

Pod 名称。

mse-7413****-159616656****-reg-center-0-0
SingleTunnelVipstring

单线程 IP。

192.168.XX.XX
InternetIpstring

公网 IP。

47.98.XX.XX
Ipstring

实例 IP。

10.12.XX.XX
Rolestring

角色。

Peer
HealthStatusstring

实例健康状态。

Running
CreationTimestampstring

创建时间戳。

1578575377732
Zonestring

可用区。

cn-shanghai-f
IntranetDomainstring

私网域名。

mse-7413****-eureka.mse.aliyuncs.com
InternetDomainstring

公网域名。

mse-7413****-p.eureka.mse.aliyuncs.com
PayInfostring

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

按量付费
InternetAddressstring

公网地址。

47.98.XX.XX
InstanceIdstring

实例 ID。

mse-cn-st21ri2****
AclEntryListstring

白名单列表。

[]
HealthStatusstring

集群健康状态。

RESTART_SUCCESS
InitCostTimelong

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

98408
RegionIdstring

地域 ID。

cn-hangzhou
AclIdstring

白名单 ID。

acl-bp17020kiqvzutwwj****
Cpuinteger

CPU 数量。

1
ClusterTypestring

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

Nacos-Ans
ClusterNamestring

集群名称。

mse-bc1a29b0-160230875****
InitStatusstring

集群创建状态。

RESTART_SUCCESS
InternetPortstring

私网端口。

8761
AppVersionstring

APP 版本。

1.2.1
NetTypestring

网络类型,取值如下:

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

集群版本。

1.2.1
ClusterSpecificationstring

引擎规格。

MSE_SC_1_2_200_c
VSwitchIdstring

交换机 ID。

vsw-xxx-xxxx
ConnectionTypestring

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

  • slb
  • eni
slb
MseVersionstring

MSE 版本号

mse_basic
ChargeTypestring

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

按量付费
OrderClusterVersionstring

原始订单版本号。

1.2.0
Tagsobject

实例所绑定的标签。

ResourceGroupIdstring

资源组 ID。

rg-aek2dhgysj*****
ErrorCodestring

错误码。

mse-100-000
Successboolean

请求结果,取值如下:

  • 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 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-05-17API 内部配置变更,不影响调用查看变更详情