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/{Subscription 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. | ||||||
Context | String | A client-supplied string that is stored with the event destination subscription. | ||||||
Protocol | String | “Redfish” | ||||||
HttpHeaders | Array | This is for setting HTTP headers, such as authorization information. This object will be null on a GET. | ||||||
HttpHeaders[N] | Object | 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. | ||||||
SubordinateResources | Boolean | By setting this to true and specifying OriginResources, this indicates the subscription will be for events from the OriginsResources specified and also all subordinate resources. | ||||||
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. | ||||||
EventFormatType | String | Valid values: “Event”, “MetricReport” (MetricReport type event is not supported yet) | ||||||
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 | ||||||
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] | Link | Reference to the resource for which the service will only send related events. | ||||||
SubscriptionType | String | Valid values: “RedfishEvent”, “SSE” | ||||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"HttpHeaders": [],
"Id": "3A048D0E",
"SubordinateResources": null,
"Context": "Test_Context",
"MessageIds": [],
"EventFormatType": "Event",
"ResourceTypes": [],
"OriginResources@odata.count": 0,
"Protocol": "Redfish",
"Name": "Destination",
"@odata.id": "/redfish/v1/EventService/Subscriptions/3A048D0E",
"RegistryPrefixes": [
"EventRegistry"
],
"@odata.type": "#EventDestination.v1_5_0.EventDestination",
"SubscriptionType": "RedfishEvent",
"Destination": "https://192.168.0.2:443",
"@odata.etag": "\"1575571584025\"",
"OriginResources": [],
"Description": "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.",
"Status": {
"State": "Enabled"
}
}