跳到主要内容

POST – 创建订阅

创建 Redfish 服务的订阅以将事件发送给订阅者。

请求 URL

POST https://<BMC_IPADDR>/redfish/v1/EventService/Subscriptions

请求正文

字段类型描述

Destination

字符串

必需。此属性应包含要将事件发送到的目标的 URI。

如果 Protocol 为 Redfish,则此字段为 HTTP/HTTPS URI。

如果 Protocol 为 SNMPv1,则此字段为 RFC1157 定义的 URI。

如果 Protocol 为 SNMPv3,则此字段为 RFC3411 和 RFC3418 定义的 URI。

如果 Protocol 为 SMTP,则此字段为 RFC5321 定义的 SMTP URI。

Protocol

字符串

必需。支持的协议为“Redfish”、“SMTP”、“SNMPv1”和“SNMPv3”。

SubscriptionType

字符串

可选。如果未提供,则默认值为“RedfishEvent”。

有效值:“RedfishEvent”、“SSE”

DeliveryRetryPolicy

字符串

可选。如果未提供,则默认值为“TerminateAfterRetries”。

有效值:“TerminateAfterRetries”、“SuspendRetries”、“RetryForever”或“RetryForeverWithBackoff”

EventFormatType

字符串

可选。如果未提供,则默认值为“Event”。

有效值:“Event”、“MetricReport”

(尚不支持 MetricReport 类型事件)

Context

字符串

可选。如果未提供,则默认值为空。

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

HttpHeaders

数组

可选。如果未提供,则默认值为空。

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

RegistryPrefixes

数组

可选。如果未提供,则默认值为空。

项:字符串

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

MessageIds

数组

可选。如果未提供,则默认值为空。

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

MetricReportDefinitions

数组

可选。如果未提供,则默认值为空。

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

ResourceTypes

数组

可选。如果未提供,则默认值为空。

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

OriginResources

数组

可选。如果未提供,则默认值为空。

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

SubordinateResources

布尔

可选。如果未提供,则默认值为空。

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

IncludeOriginOfCondition

布尔

可选。如果未提供,则默认值为 false。

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

响应正文

用于响应创建的订阅资源,使用 GET 方法引用事件订阅的响应正文。

状态代码

HTTP 状态代码错误消息 ID
201Created
400BadRequest、PropertyValueNotInList
500InternalError