主页
产品
OpenShift Container Platform
4.10
监控
11.5. 将应用程序订阅到裸机事件 REST API 参考

11.5. 将应用程序订阅到裸机事件 REST API 参考

使用裸机事件 REST API 订阅应用程序到父节点上生成的裸机事件。

使用资源地址 /cluster/node/<node_name>/redfish/event 将应用程序订阅到 Redfish 事件，其中 <node_name> 是运行应用程序的集群节点。

在单独的应用程序 pod 中部署 cloud-event-consumer 应用程序容器和 cloud-event-proxy sidecar 容器。cloud-event-consumer 应用订阅应用容器集中的 cloud-event-proxy 容器。

使用以下 API 端点，将 cloud-event-consumer 应用程序订阅到 Redfish 事件，这些事件由 cloud-event-proxy 容器发布，位于应用程序 pod 中的 http://localhost:8089/api/ocloudNotifications/v1/：

/api/ocloudNotifications/v1/subscriptions
- POST ：创建新订阅
- GET ：删除订阅列表
/api/ocloudNotifications/v1/subscriptions/<subscription_id>
- GET ：返回指定订阅 ID 的详情
api/ocloudNotifications/v1/subscriptions/status/<subscription_id>
- PUT ：为指定订阅 ID 创建新状态 ping 请求
/api/ocloudNotifications/v1/health
- GET：返回 ocloudNotifications API 的健康状况

注意

9089 是在应用程序 Pod 中部署的 cloud-event-consumer 容器的默认端口。您可以根据需要为应用程序配置不同的端口。

api/ocloudNotifications/v1/subscriptions

HTTP 方法

GET api/ocloudNotifications/v1/subscriptions

描述

返回订阅列表。如果订阅存在，则返回 200 OK 状态代码以及订阅列表。

API 响应示例

[
 {
  "id": "ca11ab76-86f9-428c-8d3a-666c24e34d32",
  "endpointUri": "http://localhost:9089/api/ocloudNotifications/v1/dummy",
  "uriLocation": "http://localhost:8089/api/ocloudNotifications/v1/subscriptions/ca11ab76-86f9-428c-8d3a-666c24e34d32",
  "resource": "/cluster/node/openshift-worker-0.openshift.example.com/redfish/event"
 }
]

[
 {
  "id": "ca11ab76-86f9-428c-8d3a-666c24e34d32",
  "endpointUri": "http://localhost:9089/api/ocloudNotifications/v1/dummy",
  "uriLocation": "http://localhost:8089/api/ocloudNotifications/v1/subscriptions/ca11ab76-86f9-428c-8d3a-666c24e34d32",
  "resource": "/cluster/node/openshift-worker-0.openshift.example.com/redfish/event"
 }
]

Copy to Clipboard

Toggle word wrap

HTTP 方法

POST api/ocloudNotifications/v1/subscriptions

描述

创建新订阅。如果订阅成功创建，或者已存在，则返回 201 Created 状态代码。

Expand

表 11.1. 查询参数
参数	类型
subscription	data

有效负载示例

{
  "uriLocation": "http://localhost:8089/api/ocloudNotifications/v1/subscriptions",
  "resource": "/cluster/node/openshift-worker-0.openshift.example.com/redfish/event"
}

{
  "uriLocation": "http://localhost:8089/api/ocloudNotifications/v1/subscriptions",
  "resource": "/cluster/node/openshift-worker-0.openshift.example.com/redfish/event"
}

Copy to Clipboard

Toggle word wrap

api/ocloudNotifications/v1/subscriptions/<subscription_id>

HTTP 方法

GET api/ocloudNotifications/v1/subscriptions/<subscription_id>

描述

返回 ID 为 <subscription_id> 的订阅详情

Expand

表 11.2. 查询参数
参数	类型
`<subscription_id>`	字符串

API 响应示例

{
  "id":"ca11ab76-86f9-428c-8d3a-666c24e34d32",
  "endpointUri":"http://localhost:9089/api/ocloudNotifications/v1/dummy",
  "uriLocation":"http://localhost:8089/api/ocloudNotifications/v1/subscriptions/ca11ab76-86f9-428c-8d3a-666c24e34d32",
  "resource":"/cluster/node/openshift-worker-0.openshift.example.com/redfish/event"
}

{
  "id":"ca11ab76-86f9-428c-8d3a-666c24e34d32",
  "endpointUri":"http://localhost:9089/api/ocloudNotifications/v1/dummy",
  "uriLocation":"http://localhost:8089/api/ocloudNotifications/v1/subscriptions/ca11ab76-86f9-428c-8d3a-666c24e34d32",
  "resource":"/cluster/node/openshift-worker-0.openshift.example.com/redfish/event"
}

Copy to Clipboard

Toggle word wrap

api/ocloudNotifications/v1/subscriptions/status/<subscription_id>

HTTP 方法

PUT api/ocloudNotifications/v1/subscriptions/status/<subscription_id>

描述

为 ID 为 <subscription_id> 的订阅创建一个新的状态 ping 请求。如果订阅存在，状态请求将成功，并返回 202 Accepted 状态代码。

Expand

表 11.3. 查询参数
参数	类型
`<subscription_id>`	字符串

API 响应示例

{"status":"ping sent"}

{"status":"ping sent"}

Copy to Clipboard

Toggle word wrap

api/ocloudNotifications/v1/health/

HTTP 方法

GET api/ocloudNotifications/v1/health/

描述

返回 ocloudNotifications REST API 的健康状况。

API 响应示例

OK

OK

Copy to Clipboard

Toggle word wrap

返回顶部

11.5. 将应用程序订阅到裸机事件 REST API 参考

api/ocloudNotifications/v1/subscriptions

HTTP 方法

描述

HTTP 方法

描述

api/ocloudNotifications/v1/subscriptions/<subscription_id>

HTTP 方法

描述

api/ocloudNotifications/v1/subscriptions/status/<subscription_id>

HTTP 方法

描述

api/ocloudNotifications/v1/health/

HTTP 方法

描述

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links