ListClusters - 查询集群列表

查询注册配置中心集群列表。

调试

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

调试

授权信息

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

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

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

mse:ListClusters

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RequestPars

string

扩展请求参数,JSON 格式。

{}

PageNum

integer

页码。

1

PageSize

integer

每页展示集群数。

10

ClusterAliasName

string

集群名字,支持模糊匹配。

cluster

RegionId

string

集群所在地域,MSE 支持的地域。

cn-hangzhou

ResourceGroupId

string

资源组 ID。资源组详情请参见查看资源组基本信息。

rg-acfmxbzafebvvfa

Tag

array

标签列表,最多包含 20 个子项

object

标签。

Key

string

标签键。

env

Value

string

标签值。

prd

KeyId

string

如果是 nacos 集群,查询绑定了指定 keyId 的实例

key-hzz67774641bsp21vhj4h

AcceptLanguage

string

返回信息的语言类型:

  • zh:中文

  • en:英文

zh

返回参数

名称

类型

描述

示例值

object

字符串对象。

HttpCode

string

HTTP 状态码。

202

TotalCount

integer

实例总数。

7

RequestId

string

请求 ID。

69AD2AA7-DB47-449B-941B-B14409DF****

Message

string

信息。

请求处理成功

PageSize

integer

每页展示实例数。

10

PageNumber

integer

页码。

1

Data

array

数据概览。

object

字符串对象。

EndDate

string

集群截止时间。

2021-08-01 00:00:00

IntranetDomain

string

私网域名。

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

InternetDomain

string

公网域名。

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

CreateTime

string

集群创建时间。

2020-07-31 11:36:08

ChargeType

string

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

按量付费

IntranetAddress

string

私网地址。

192.168.XX.XX

InstanceId

string

实例 ID。

mse-cn-st21ri2****

InternetAddress

string

公网地址。

47.98.XX.XX

ClusterAliasName

string

集群别名。

mse-7413****

ClusterType

string

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

Eureka

InitStatus

string

初始化状态。

RESTART_SUCCESS

AppVersion

string

APP 版本。

1.9.3

CanUpdate

boolean

是否能够升级。

true

VersionCode

string

版本信息。

EUREKA_1_9_3

InstanceCount

integer

集群数量。

2

ClusterName

string

集群名字。

mse-cn-st21ri2****

MseVersion

string

集群所使用的版本类别。

mse_pro

Tags

object

实例所绑定的标签。

ResourceGroupId

string

实例所属的资源组 ID。

rg-acfmv7jiavm4uxa

VpcId

string

集群所处的 VPC ID。

vpc-bp1hcg467ekqsv0zr****

MaintenancePeriod

object

运维时间窗口

StartTime

string

运维时间窗口开始时间

02:00

EndTime

string

运维时间窗口结束时间

06:00

VersionLifecycle

string

ErrorCode

string

错误码。

mse-100-000

Success

boolean

请求结果,取值如下:

  • true:请求成功。

  • false:请求失败。

true

示例

正常返回示例

JSON格式

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Message": "请求处理成功",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "EndDate": "2021-08-01 00:00:00",
      "IntranetDomain": "mse-7413****-eureka.mse.aliyuncs.com",
      "InternetDomain": "mse-7413****-p.eureka.mse.aliyuncs.com",
      "CreateTime": "2020-07-31 11:36:08",
      "ChargeType": "按量付费",
      "IntranetAddress": "192.168.XX.XX",
      "InstanceId": "mse-cn-st21ri2****",
      "InternetAddress": "47.98.XX.XX",
      "ClusterAliasName": "mse-7413****",
      "ClusterType": "Eureka",
      "InitStatus": "RESTART_SUCCESS",
      "AppVersion": "1.9.3",
      "CanUpdate": true,
      "VersionCode": "EUREKA_1_9_3",
      "InstanceCount": 2,
      "ClusterName": "mse-cn-st21ri2****",
      "MseVersion": "mse_pro",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "ResourceGroupId": "rg-acfmv7jiavm4uxa",
      "VpcId": "vpc-bp1hcg467ekqsv0zr****",
      "MaintenancePeriod": {
        "StartTime": "02:00",
        "EndTime": "06:00"
      },
      "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

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

变更历史

更多信息,参考变更详情