GET – 事件订阅
使用 GET 方法检索服务器的事件订阅条目中的属性。
请求 URL
GET https://<BMC_IPADDR>/redfish/v1/EventService/Subscriptions/{Subscription ID}
请求正文
无
响应正文
| 字段 | 类型 | 描述 | ||||||
|---|---|---|---|---|---|---|---|---|
Id | 字符串 | 在订阅集合中唯一标识此资源。 | ||||||
Name | 字符串 | “Destination” | ||||||
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.” | ||||||
Destination | 字符串 | 此属性应包含要将事件发送到的目标的 URI。 | ||||||
Context | 字符串 | 与事件目标订阅一起存储的由客户端提供的字符串。 | ||||||
Protocol | 字符串 | “Redfish” | ||||||
HttpHeaders | 数组 | 用于设置 HTTP 标头，例如授权信息。此对象在 GET 中将为 null。 | ||||||
HttpHeaders[N] | 对象 | 用于设置 HTTP 标头，例如授权信息。此对象在 GET 中将为 null。 | ||||||
MessageIds | 数组 | 服务将仅发送的 MessageIds 的列表。如果此属性不存在或数组为空，则具有任何 MessageId 的事件都将发送到订阅者。 | ||||||
MessageIds[N] | 字符串 | 服务将发送的消息 ID。 | ||||||
SubordinateResources | 布尔 | 通过将此字段设置为 true 并指定 OriginResources，这表示订阅来自指定 OriginsResources 及所有从属资源的事件。 | ||||||
ResourceTypes | 数组 | 可在订阅的 ResourceType 中指定的 @odata.type 值（架构名称）的列表。 | ||||||
ResourceTypes[N] | 字符串 | ResourceTypes 数组元素 注 无法按 ResourceType 筛选警报事件。 | ||||||
EventFormatType | 字符串 | 有效值：“Event”、“MetricReport” （尚不支持 MetricReport 类型事件） | ||||||
RegistryPrefixes | 数组 | 项：字符串 项数：映射到资源 /redfish/v1/Registries 下的成员 | ||||||
RegistryPrefixes[N] | 字符串 | 映射到资源 /redfish/v1/Registries 下的成员 | ||||||
OriginResources | 数组 | 服务将仅发送相关事件的资源列表。如果此属性不存在或数组为空，则来自任何资源的事件都将发送到订阅者。 | ||||||
OriginResources[N] | 链接 | 服务将仅发送相关事件的资源的引用。 | ||||||
SubscriptionType | 字符串 | 有效值：“RedfishEvent”、“SSE” | ||||||
状态代码
| HTTP 状态代码 | 错误消息 ID |
|---|---|
| 500 | InternalError |
示例
返回以下示例 JSON 响应：
{
"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"
}
}