跳到主要内容

GET – 事件订阅

使用 GET 方法检索服务器的事件订阅条目中的属性。

请求 URL

GET https://<BMC_IPADDR>/redfish/v1/EventService/Subscriptions/{random_ID}

请求正文

响应正文

字段类型描述

Id

字符串

在订阅集合中唯一标识此资源。

Name

字符串

目标

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。

Protocol

字符串

Redfish

Context

字符串

与事件目标订阅一起存储的由客户端提供的字符串。

EventFormatType

字符串

有效值:“Event”、“MetricReport”

(尚不支持 MetricReport 类型事件)

HttpHeaders

数组

用于设置 HTTP 标头,例如授权信息。此对象在 GET 中将为 null。

MessageIds

数组

服务将仅发送的 MessageIds 的列表。如果此属性不存在或数组为空,则具有任何 MessageId 的事件都将发送到订阅者。

 

MessageIds[N]

字符串

服务将发送的消息 ID。

OriginResources

数组

服务将仅发送相关事件的资源列表。如果此属性不存在或数组为空,则来自任何资源的事件都将发送到订阅者。

 

OriginResources[N]

对象

已展开。

  

@odata.id

链接

订阅资源的链接。

MetricReportDefinitions

数组

指标报告定义的列表。如果此属性为空数组或不存在,则不基于 MetricReportDefinition 进行筛选。

 

MetricReportDefinitions[N]

对象

已展开。

  

@odata.id

链接

订阅资源的链接。

SubscriptionType

字符串

有效值:“RedfishEvent”、“SSE”

RegistryPrefixes

数组

项:字符串

项数:映射到资源 /redfish/v1/Registries 下的成员

 

RegistryPrefixes[N]

字符串

映射到资源 /redfish/v1/Registries 下的成员

ResourceTypes

数组

可在订阅的 ResourceType 中指定的 @odata.type 值(架构名称)的列表。

 

ResourceTypes[N]

字符串
ResourceTypes 数组元素
无法按 ResourceType 筛选警报事件。

SubordinateResources

布尔

该订阅是否针对 OriginResources 数组及其下属资源中的事件。

DeliveryRetryPolicy

字符串“TerminateAfterRetries”或“SuspendRetries”或“RetryForever”或“RetryForeverWithBackoff”

DeliveryRetryPolicy@Redfish.AllowableValues

数组

项:字符串

项数:4

 

DeliveryRetryPolicy@Redfish.AllowableValues[N]

字符串

“TerminateAfterRetries”、“SuspendRetries”、“RetryForever”、“RetryForeverWithBackoff”

IncludeOriginOfCondition

布尔

订阅的事件是否还包括引用 OriginOfCondition 属性的整个资源。

Status

对象

已展开。

 

State

字符串

“Enabled”或“Disabled”

Actions

对象

已展开。

 

#EventDestination.ResumeSubscription

对象

仅“RedfishEvent”订阅支持此操作。请参阅“Actions”。

  

title

字符串

ResumeSubscription

  

target

链接

/redfish/v1/EventService/Subscriptions/{random ID}/Actions/EventDestination.ResumeSubscription

状态代码

HTTP 状态代码错误消息 ID
500InternalError