GET – Event Subscription Instance
Request
GET https://{{ip}}/redfish/v1/EventService/Subscriptions/{{Subscriptions_instance}}
Content-Type: application/json
This resource shall be used to represent resources that represent the Event Subscriptions and conforms to the Event Destination Schema.
A subscription instance is shown only when events are subscribed or posted using POST Action.
Response
The response is a JSON object that contains the following parameters:
Name | Type | Read only | Description | ||||||||
| (OData Attributes) | Refer to OData Support | ||||||||||
| Oem | Object | OEM Extension (Optional), Refer to Resource Complex Types | |||||||||
Id(M) | String | True | Refer to Resource Type Definitions | ||||||||
Name(M) | String | True | |||||||||
Description | String | True | |||||||||
Destination | String | True | This property shall contain a URI to the destination where the events will be sent. | ||||||||
Context | String | False | A client-supplied Description that is stored with the event destination subscription. This property shall contain a client supplied context that will remain with the connection through the connection’s lifetime. | ||||||||
SubscriptionType | String | True | The value of this property shall indicate the type of subscription for events. If this property is not present, thebSubscriptionType shall be assumed to be RedfishEvent. RedfishEvent SubscriptionType indicates that the subscription follows the Redfish specification for event notifications, which is done by a service sending an HTTP POST to the subscriber's destination URI. | ||||||||
Protocol | String | True | The protocol type of the event connection. This property shall contain the protocol type that the event will use for sending the event to the destination. A value of Redfish shall be used to indicate that the event type shall adhere to that defined in the Redfish specification. "Enum": [ "Redfish”] | ||||||||
MessageIds | Array | True | 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. | ||||||||
OriginResources | Array | True | A list of resources for which the service will only send relateDevents. If this property is absent or the array is empty, then Events originating from any resource will be sent to the subscriber. | ||||||||
OriginResource s@odata.count | Number | True | The number of items in a collection | ||||||||
Actions | Object | True | This object will contain the actions for this resource under Oem property if any. | ||||||||
SubordinateResources | Boolean | True | This property specifying OriginResources when set to true. Note Default value is false. | ||||||||
EventFormarType | String | True | This property shall contain the types of message that will be sent to the Event destination. MetricReport: The Subscription destination will receive JSON bodies as MetricReport format only when the TelemetryService has generateDa new Metric Report or updateDan existing Metric Report. Event: The Subscription destination will receive JSON bodies as Event format for all other types of Events. | ||||||||
RegistryPrefixes | Array | True | A list of Prefixes for the Message Registries that contain the MessageIds. | ||||||||
ResourceTypes | Array | True | A list of Resource type values that corresponds to the OriginOfCondition. | ||||||||
| Status | Object | True | Refer to Resource Complex Types The state will be changed to Disabled and Health and HealthRollup to Critical when the subscription gets suspended. | ||||||||
| MetricReportDefinitions | Array | True |
| ||||||||
| DeliveryRetryPolicy | String | False |
|