文档

ListClusters - 查询集群列表

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

扩展请求参数,JSON 格式。

{}
PageNuminteger

页码。

1
PageSizeinteger

每页展示集群数。

10
ClusterAliasNamestring

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

cluster
RegionIdstring

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

cn-hangzhou
ResourceGroupIdstring

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

rg-acfmxbzafebvvfa
Tagarray<object>

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

object

标签。

Keystring

标签键。

env
Valuestring

标签值。

prd
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

字符串对象。

HttpCodestring

HTTP 状态码。

202
TotalCountinteger

实例总数。

7
RequestIdstring

请求 ID。

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

信息。

请求处理成功
PageSizeinteger

每页展示实例数。

10
PageNumberinteger

页码。

1
Dataarray<object>

数据概览。

object

字符串对象。

EndDatestring

集群截止时间。

2021-08-01 00:00:00
IntranetDomainstring

私网域名。

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

公网域名。

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

集群创建时间。

2020-07-31 11:36:08
ChargeTypestring

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

按量付费
IntranetAddressstring

私网地址。

192.168.XX.XX
InstanceIdstring

实例 ID。

mse-cn-st21ri2****
InternetAddressstring

公网地址。

47.98.XX.XX
ClusterAliasNamestring

集群别名。

mse-7413****
ClusterTypestring

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

Eureka
InitStatusstring

初始化状态。

RESTART_SUCCESS
AppVersionstring

APP 版本。

1.9.3
CanUpdateboolean

是否能够升级。

true
VersionCodestring

版本信息。

EUREKA_1_9_3
InstanceCountlong

集群数量。

2
ClusterNamestring

集群名字。

mse-cn-st21ri2****
MseVersionstring

集群所使用的版本类别。

mse_pro
Tagsobject

实例所绑定的标签。

ResourceGroupIdstring

实例所属的资源组 ID。

rg-acfmv7jiavm4uxa
VpcIdstring

集群所处的 VPC ID。

vpc-bp1hcg467ekqsv0zr****
MaintenancePeriodobject

运维时间窗口

StartTimestring

运维时间窗口开始时间

02:00
EndTimestring

运维时间窗口结束时间

06:00
ErrorCodestring

错误码。

mse-100-000
Successboolean

请求结果,取值如下:

  • 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"
      }
    }
  ],
  "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-10-19OpenAPI 返回结构发生变更查看变更详情
2023-08-09OpenAPI 返回结构发生变更查看变更详情
2023-04-25API 内部配置变更,不影响调用查看变更详情
2021-10-20OpenAPI 返回结构发生变更查看变更详情