Viewing information about the cluster

GET /api/v1/events/clusters

Access: administrator, analyst, and operator.

The main tenant clusters are accessible to all users.

Query parameters (URL Query)

Name	Data type	Mandatory	Description	Value example
page	number	No	Page number. Starts with 1. The page size is 250 entries. If the parameter is not specified, the default value is 1.	1
id	string	No	Cluster ID. If the parameter is specified several times, then a list is generated and the logical OR operator is applied	00000000-0000-0000-0000-000000000000
TenantID	string	No	Tenant ID. If the parameter is specified several times, then a list is generated and the logical OR operator is applied. If the user does not have the required role in the specified tenant, then this tenant is ignored.	00000000-0000-0000-0000-000000000000
name	string	No	Cluster name. Case-insensitive regular expression (PCRE).	cluster ^My cluster$

Response

HTTP code: 200

Format: JSON

type Response []Cluster

type Cluster struct {

ID string `json:"id"`

Name string `json:"name"`

TenantID string `json:"tenantID"`

TenantName string `json:"tenantName"`

}

Possible errors

HTTP code	Description	message field value	details field value
400	Invalid value of the "page" parameter	invalid query parameter value	page
500	Any other internal errors	variable	variable