#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.

  Properties:

  • detail: object

    Detailed event information.

    Properties:

    • cluster_name: string

      Name of the cluster.

    • cluster_uuid: string

      Unique identifier for the cluster.

    • event: object

      Event data.

      Properties:

      • count: integer

        Number of times the event has occurred.

      • firstTimestamp: string

        Time when the event first occurred.

      • lastTimestamp: string

        Time when the event last occurred.

      • message: string

        Event message.

      • reason: string

        Reason for the event.

      • source: object

        Source of the event.

        Properties:

        • component: string

          Component that generated the event.

      • type: string

        Event type (e.g. Normal, Warning).

      • involvedObject: object

        The object involved in the event.

        Properties:

        • apiVersion: string
        • kind: string
        • name: string
        • namespace: string
        • resourceVersion: string
        • uid: string

          Unique identifier of the object.

      • metadata: object

        Metadata of the event.

        Properties:

        • creationTimestamp: string

          Creation time of the event record.

        • name: string
        • namespace: string
        • resourceVersion: string
        • selfLink: string
        • uid: string
    • operation: string

      Operation that caused the event.

    • operator: string

      Operator that performed the operation.

    • source: string

      Source of the event (e.g. kubernetes).

  • log_level: integer

    Log level for the event.

  • resource_id: string

    Resource identifier for the event.

  • resource_type: string

    Type of the resource (e.g. Pod).

  • time: number

    Timestamp of the event occurrence.

/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.

  Properties:

  • detail: object

    Detailed event information.

    Properties:

    • cluster_name: string

      Name of the cluster.

    • cluster_uuid: string

      Unique identifier for the cluster.

    • event: object

      Event data.

      Properties:

      • count: integer

        Number of times the event has occurred.

      • firstTimestamp: string

        Time when the event first occurred.

      • lastTimestamp: string

        Time when the event last occurred.

      • message: string

        Event message.

      • reason: string

        Reason for the event.

      • source: object

        Source of the event.

        Properties:

        • component: string

          Component that generated the event.

      • type: string

        Event type (e.g. Normal, Warning).

      • involvedObject: object

        The object involved in the event.

        Properties:

        • apiVersion: string
        • kind: string
        • name: string
        • namespace: string
        • resourceVersion: string
        • uid: string

          Unique identifier of the object.

      • metadata: object

        Metadata of the event.

        Properties:

        • creationTimestamp: string

          Creation time of the event record.

        • name: string
        • namespace: string
        • resourceVersion: string
        • selfLink: string
        • uid: string
    • operation: string

      Operation that caused the event.

    • operator: string

      Operator that performed the operation.

    • source: string

      Source of the event (e.g. kubernetes).

  • log_level: integer

    Log level for the event.

  • resource_id: string

    Resource identifier for the event.

  • resource_type: string

    Type of the resource (e.g. Pod).

  • time: number

    Timestamp of the event occurrence.