文档首页/ 事件网格 EG/ API参考/ API/ 专业版事件流集群管理/ 查询专业版事件流集群列表
更新时间:2025-03-31 GMT+08:00
分享

查询专业版事件流集群列表

功能介绍

查询专业版事件流集群列表

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/eventrouter/clusters

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户资源空间ID

表2 Query参数

参数

是否必选

参数类型

描述

fuzzy_name

String

名称模糊查询

offset

String

偏移量

limit

String

每页显示的数量

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID

表5 响应Body参数

参数

参数类型

描述

total

Integer

总数

size

Integer

本页数量

items

Array of EventRouterClusterInfo objects

对象列表

表6 EventRouterClusterInfo

参数

参数类型

描述

cluster_id

String

专业版事件流集群ID

name

String

集群名称。约束:集群名称由大小英文字母、数字、点、中划线和下划线组成,必须以大小英文字母或数字开头,最多128个字符。

description

String

集群描述,约束:集群描述不能超过256位。

source_type

String

源端类型

sink_type

String

目标端类型

subnet_id

String

子网ID

vpc_id

String

虚拟私有云ID

zone_names

String

可用区名称

status

String

作业状态

job_count

Number

当前集群下作业数量

flavor

String

规格

charging_mode

String

计费模式

err_code

String

错误码

err_message

String

错误原因

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

请求示例

查询专业版事件流集群列表

GET https://{eg_endpoint}/v1/{project_id}/eventrouter/clusters?limit=1000&offset=0

响应示例

状态码:200

请求成功

{
  "size" : 1,
  "total" : 1,
  "items" : [ {
    "cluster_id" : "fac59513-6c18-4266-bc81-5d412dfc1925",
    "name" : "cluster-ifpcv5u4",
    "description" : null,
    "source_type" : "KAFKA",
    "sink_type" : "KAFKA",
    "status" : "RUNNING",
    "job_count" : 1,
    "err_code" : null,
    "err_message" : null,
    "created_time" : "2024-05-16T11:46:07Z",
    "updated_time" : "2024-05-16T11:46:07Z",
    "vpc_id" : "199f632d-34e7-4915-b4d8-1bc4e2824867",
    "subnet_id" : "0d1799e1-116e-4551-92dc-02dd8a860072",
    "zone_names" : "az0"
  } ]
}

状态码

状态码

描述

200

请求成功

错误码

请参见错误码

相关文档