logo
Doom
English
简体中文
English
简体中文
logo
Doom
Introduction
Getting Started

Usage

Configuration
Convention
Markdown
MDX
Internationalization
API Documentation
Permission Description Document
Referencing Documents
Deployment

APIs

Advanced API

Event APIs

Search

Log APIs

Aggregation
Search
CodeQualityTaskSummary
Projects

Workload APIs

DaemonSet [apps/v1]
Deployments [apps/v1]

CRDs

ArtifactCleanupRun

Public References

CodeQuality
CodeQualityBranch
📝 Edit this page on GitHub
Previous PageEvent APIs
Next PageLog APIs

#Search

/platform/events.alauda.io/v1/events#

getRetrieve Kubernetes events#

Retrieve the k8s events using query parameters.

Parameters#

  • start_time (in query): number required

    Required: Unix timestamp for start time.

  • end_time (in query): number required

    Required: Unix timestamp for end time.

  • cluster (in query): string required

    Required: Name of the Kubernetes cluster.

  • pageno (in query): number

    Optional: Page number to retrieve.

  • size (in query): number

    Optional: Page size, defaults to 30.

  • project (in query): string

    Optional: Name of the project.

  • namespace (in query): string

    Optional: Event's namespace. Use comma-separated values for multiple namespaces.

  • kind (in query): string

    Optional: Event related resource kind. Use comma-separated values for multiple kinds.

  • name (in query): string

    Optional: Filter events by name (fuzzy matching).

  • filters (in query): string

    Optional: Custom filters.

  • type (in query): string

    Optional: Event type (e.g. Normal, Warning, etc.).

Response#

  • 200EventsResponse: Successful retrieval of events.

EventsResponse#

  • items: []EventItem

    List of event items.

  • total_items: integer

    Total number of event items.

  • total_page: integer

    Total number of pages.

EventItem#

  • spec: object

    Specification details for the event.

/platform/events.alauda.io/v1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/events#

getRetrieve Kubernetes events for a specific project and namespace#

Retrieve the k8s events with a business view. For these requests, the cluster, project, and namespace fields must be provided.

Parameters#

  • projectName (in path): string required

    Required: Name of the project.

  • clusterName (in path): string required

    Required: Name of the cluster.

  • namespace (in path): string required

    Required: Namespace for the events.

  • start_time (in query): number required

    Required: Unix timestamp for start time.

  • end_time (in query): number required

    Required: Unix timestamp for end time.

  • cluster (in query): string required

    Required: Name of the Kubernetes cluster.

  • pageno (in query): number

    Optional: Page number to retrieve.

  • size (in query): number

    Optional: Page size, defaults to 30.

  • kind (in query): string

    Optional: Event related resource kind. Use comma-separated values for multiple kinds.

  • name (in query): string

    Optional: Filter events by name (fuzzy matching).

  • filters (in query): string

    Optional: Custom filters.

  • type (in query): string

    Optional: Event type (e.g. Normal, Warning, etc.).

Response#

  • 200EventsResponse: Successful retrieval of events.

EventsResponse#

  • items: []EventItem

    List of event items.

  • total_items: integer

    Total number of event items.

  • total_page: integer

    Total number of pages.

EventItem#

  • spec: object

    Specification details for the event.