GET – Event subscriptions
Use the GET method to retrieve properties in event subscription entries for a server.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/EventService/Subscriptions/{random_ID}
Request body
None
Response body
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
Id | String | Uniquely identifies the resource within the collection of the subscriptions. | ||||||
Name | String | Destination | ||||||
Description | String | This resource represents the target of an event subscription, including the types of events subscribed and context to provide to the target in the Event payload. | ||||||
Destination | String | This property shall contain a URI to the destination where the events will be sent. | ||||||
Protocol | String | Redfish | ||||||
Context | String | A client-supplied string that is stored with the event destination subscription. | ||||||
EventFormatType | String | Valid values: “Event”, “MetricReport” (MetricReport type event is not supported yet) | ||||||
HttpHeaders | Array | This is for setting HTTP headers, such as authorization information. This object will be null on a GET. | ||||||
MessageIds | Array | A list of MessageIds that the service will only send. If this property is absent or the array is empty, then Events with any MessageId will be sent to the subscriber. | ||||||
MessageIds[N] | String | Message Id that the service will send. | ||||||
OriginResources | Array | A list of resources for which the service will only send related events. If this property is absent or the array is empty, then Events originating from any resource will be sent to the subscriber. | ||||||
OriginResources[N] | Object | Expanded. | ||||||
@odata.id | Link | Link to subscribed resources. | ||||||
MetricReportDefinitions | Array | A list of metric report definitions. If this property is an empty array or is absent, no filtering based upon MetricReportDefinition. | ||||||
MetricReportDefinitions[N] | Object | Expanded. | ||||||
@odata.id | Link | Link to subscribed resources. | ||||||
SubscriptionType | String | Valid values: “RedfishEvent”, “SSE” | ||||||
RegistryPrefixes | Array | Item: string Item count: maps to members under the resource /redfish/v1/Registries | ||||||
RegistryPrefixes[N] | String | Maps to members under the resource /redfish/v1/Registries | ||||||
ResourceTypes | Array | A list of @odata.type values (Schema names) that can be specified in a ResourceType on a subscription. | ||||||
ResourceTypes[N] | String | Array element of ResourceTypes Note Alert event cannot be filtered by ResourceType. | ||||||
SubordinateResources | Boolean | Whether the subscription is for events in the OriginResources array and its subordinate resources. | ||||||
DeliveryRetryPolicy | String | “TerminateAfterRetries” or “SuspendRetries” or “RetryForever” or “RetryForeverWithBackoff” | ||||||
DeliveryRetryPolicy@Redfish.AllowableValues | Array | Items: string Item count: 4 | ||||||
DeliveryRetryPolicy@Redfish.AllowableValues[N] | String | “TerminateAfterRetries”, “SuspendRetries”, “RetryForever”, “RetryForeverWithBackoff” | ||||||
IncludeOriginOfCondition | Boolean | Whether the events subscribed to will also include the entire resource referenced the OriginOfCondition property. | ||||||
Status | Object | Expanded. | ||||||
State | String | “Enabled” or “Disabled” | ||||||
Actions | Object | Expanded. | ||||||
#EventDestination.ResumeSubscription | Object | Only “RedfishEvent” subscription supports this action. Refer to Actions. | ||||||
title | String | ResumeSubscription | ||||||
target | Link | /redfish/v1/EventService/Subscriptions/{random ID}/Actions/EventDestination.ResumeSubscription | ||||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |