Querying the Professional Event Stream Clusters

Function

This API is used to query the professional event stream clusters.

URI

GET /v1/{project_id}/eventrouter/clusters

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
fuzzy_name	No	String	Fuzzy query by name.
offset	No	String	Offset.
limit	No	String	Number of records displayed on each page.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 5** Response body parameters
Parameter	Type	Description
total	Integer	Total number.
size	Integer	Number of records displayed on the current page.
items	Array of EventRouterClusterInfo objects	Object list.

**Table 6** EventRouterClusterInfo
Parameter	Type	Description
cluster_id	String	Professional event stream cluster ID.
name	String	Cluster name. Start with a letter or digit, and only include letters, digits, periods (.), underscores (_), and hyphens (-). (Max. 128 characters)
description	String	Cluster description. The description can contain a maximum of 256 characters.
source_type	String	Source type.
sink_type	String	Target type.
subnet_id	String	Subnet ID.
vpc_id	String	VPC ID.
zone_names	String	AZ name.
status	String	Job status.
job_count	Number	Number of jobs in the current cluster.
flavor	String	Flavor.
charging_mode	String	Billing mode.
err_code	String	Error code.
err_message	String	Error cause.
created_time	String	UTC time when the event source is created.
updated_time	String	UTC time when the event source is updated.

Example Requests

Query the professional event stream clusters.

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

Example Responses

Status code: 200

Request succeeded.

{
  "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"
  } ]
}