Skip to content

Latest commit

 

History

History
774 lines (469 loc) · 26 KB

EventApi.md

File metadata and controls

774 lines (469 loc) · 26 KB
Raw

\EventApi

All URIs are relative to https://YOUR_CLUSTER_HOSTNAME_OR_NODE_IP:8080

Method HTTP request Description
CreateEventAlertCondition Post /platform/4/event/alert-conditions
CreateEventChannel Post /platform/3/event/channels
CreateEventEvent Post /platform/3/event/events
DeleteEventAlertCondition Delete /platform/4/event/alert-conditions/{EventAlertConditionId}
DeleteEventAlertConditions Delete /platform/4/event/alert-conditions
DeleteEventChannel Delete /platform/3/event/channels/{EventChannelId}
GetEventAlertCondition Get /platform/4/event/alert-conditions/{EventAlertConditionId}
GetEventCategories Get /platform/3/event/categories
GetEventCategory Get /platform/3/event/categories/{EventCategoryId}
GetEventChannel Get /platform/3/event/channels/{EventChannelId}
GetEventEventgroupDefinition Get /platform/4/event/eventgroup-definitions/{EventEventgroupDefinitionId}
GetEventEventgroupDefinitions Get /platform/4/event/eventgroup-definitions
GetEventEventgroupOccurrence Get /platform/3/event/eventgroup-occurrences/{EventEventgroupOccurrenceId}
GetEventEventgroupOccurrences Get /platform/3/event/eventgroup-occurrences
GetEventEventlist Get /platform/3/event/eventlists/{EventEventlistId}
GetEventEventlists Get /platform/3/event/eventlists
GetEventSettings Get /platform/3/event/settings
ListEventAlertConditions Get /platform/4/event/alert-conditions
ListEventChannels Get /platform/3/event/channels
UpdateEventAlertCondition Put /platform/4/event/alert-conditions/{EventAlertConditionId}
UpdateEventChannel Put /platform/3/event/channels/{EventChannelId}
UpdateEventEventgroupOccurrence Put /platform/3/event/eventgroup-occurrences/{EventEventgroupOccurrenceId}
UpdateEventEventgroupOccurrences Put /platform/3/event/eventgroup-occurrences
UpdateEventSettings Put /platform/3/event/settings

CreateEventAlertCondition

CreateResponse CreateEventAlertCondition(ctx, eventAlertCondition)

Create a new alert condition.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventAlertCondition EventAlertConditionCreateParams

Return type

CreateResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateEventChannel

CreateResponse CreateEventChannel(ctx, eventChannel)

Create a new channel.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventChannel EventChannelCreateParams

Return type

CreateResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateEventEvent

CreateQuotaReportResponse CreateEventEvent(ctx, eventEvent)

Create a test event.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventEvent EventEvent

Return type

CreateQuotaReportResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteEventAlertCondition

DeleteEventAlertCondition(ctx, eventAlertConditionId)

Delete the alert-condition.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventAlertConditionId string Delete the alert-condition.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteEventAlertConditions

DeleteEventAlertConditions(ctx, optional)

Bulk delete of alert conditions.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
channel string Delete only conditions for this channel

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteEventChannel

DeleteEventChannel(ctx, eventChannelId)

Delete the channel.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventChannelId string Delete the channel.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventAlertCondition

EventAlertConditions GetEventAlertCondition(ctx, eventAlertConditionId)

Retrieve the alert-condition.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventAlertConditionId string Retrieve the alert-condition.

Return type

EventAlertConditions

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventCategories

EventCategoriesExtended GetEventCategories(ctx, optional)

List all eventgroup categories.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
limit int32 Return no more than this many results at once (see resume).
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).

Return type

EventCategoriesExtended

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventCategory

EventCategories GetEventCategory(ctx, eventCategoryId)

Retrieve the eventgroup category.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventCategoryId string Retrieve the eventgroup category.

Return type

EventCategories

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventChannel

EventChannels GetEventChannel(ctx, eventChannelId)

Retrieve the channel.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventChannelId string Retrieve the channel.

Return type

EventChannels

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventEventgroupDefinition

EventEventgroupDefinitions GetEventEventgroupDefinition(ctx, eventEventgroupDefinitionId)

Retrieve the eventgroup definition.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventEventgroupDefinitionId string Retrieve the eventgroup definition.

Return type

EventEventgroupDefinitions

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventEventgroupDefinitions

EventEventgroupDefinitionsExtended GetEventEventgroupDefinitions(ctx, optional)

List all eventgroup definitions.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
category int32 Return eventgroups in the specified category
limit int32 Return no more than this many results at once (see resume).
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).

Return type

EventEventgroupDefinitionsExtended

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventEventgroupOccurrence

EventEventgroupOccurrences GetEventEventgroupOccurrence(ctx, eventEventgroupOccurrenceId)

Retrieve individual eventgroup occurrence.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventEventgroupOccurrenceId string Retrieve individual eventgroup occurrence.

Return type

EventEventgroupOccurrences

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventEventgroupOccurrences

EventEventgroupOccurrencesExtended GetEventEventgroupOccurrences(ctx, optional)

List all eventgroup occurrences.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
resolved bool Filter for resolved eventgroups
sort string The field that will be used for sorting.
begin int32 events that are in progress after this time
end int32 events that were in progress before this time
eventCount int32 events for which event_count > this
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
ignore bool Filter for ignored eventgroups
limit int32 Return no more than this many results at once (see resume).
resolver string Filter for eventgroup resolver
cause string Filter for cause
dir string The direction of the sort.

Return type

EventEventgroupOccurrencesExtended

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventEventlist

EventEventlists GetEventEventlist(ctx, eventEventlistId)

Retrieve the list of events for a eventgroup occureence.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventEventlistId string Retrieve the list of events for a eventgroup occureence.

Return type

EventEventlists

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventEventlists

EventEventlistsExtended GetEventEventlists(ctx, optional)

List all event occurrences grouped by eventgroup occurrence.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
eventInstance string Return only this event occurrence
limit int32 Return no more than this many results at once (see resume).
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).

Return type

EventEventlistsExtended

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventSettings

EventSettings GetEventSettings(ctx, )

Retrieve the settings.

Required Parameters

This endpoint does not need any parameter.

Return type

EventSettings

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListEventAlertConditions

EventAlertConditionsExtended ListEventAlertConditions(ctx, optional)

List all alert conditions.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
channels string Return only conditions for the specified channel:
sort string The field that will be used for sorting.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).

Return type

EventAlertConditionsExtended

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListEventChannels

EventChannelsExtended ListEventChannels(ctx, optional)

List all channels.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
sort string The field that will be used for sorting.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).

Return type

EventChannelsExtended

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateEventAlertCondition

UpdateEventAlertCondition(ctx, eventAlertCondition, eventAlertConditionId)

Modify the alert-condition

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventAlertCondition EventAlertCondition
eventAlertConditionId string Modify the alert-condition

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateEventChannel

UpdateEventChannel(ctx, eventChannel, eventChannelId)

Modify the channel.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventChannel EventChannel
eventChannelId string Modify the channel.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateEventEventgroupOccurrence

UpdateEventEventgroupOccurrence(ctx, eventEventgroupOccurrence, eventEventgroupOccurrenceId)

modify eventgroup occurrence.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventEventgroupOccurrence EventEventgroupOccurrence
eventEventgroupOccurrenceId string modify eventgroup occurrence.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateEventEventgroupOccurrences

UpdateEventEventgroupOccurrences(ctx, eventEventgroupOccurrences)

Modify all eventgroup occurrences, resolve or ignore all

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventEventgroupOccurrences EventEventgroupOccurrence

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateEventSettings

UpdateEventSettings(ctx, eventSettings)

Update settings

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
eventSettings EventSettings

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]