代码仓
中
TriggersCollection
更新时间: 2026/11/04
在AtomGit上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/TelemetryService/Triggers

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-Triggers资源模型的OData描述信息
@odata.idstringtrue-Triggers资源节点的访问路径
@odata.typestringtrue-Triggers资源类型
Namestringfalse-触发器集合资源名称
Members [ {arraytrue-触发器集合资源成员
Members[].@odata.idstringtrue-成员资源节点的访问路径
} ]
Members@odata.countnumbertrue-触发器集合资源成员总数

supported_methods ​

  • GET
  • POST

HTTP methods ​

GET ​

命令功能

查询触发器集合资源信息

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

URL: https://device_ip/redfish/v1/TelemetryService/Triggers

请求头:

text
X-Auth-Token: auth_value

请求消息体: 无

参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
auth_value执行该GET请求时,必须在"Headers"中携带"X-Auth-Token"值用于鉴权可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例:

http
GET <https://device_ip/redfish/v1/TelemetryService/Triggers>

请求头:

text
X-Auth-Token: 123456789***********************

请求消息体:无

响应样例:

json
{
"@odata.context": "/redfish/v1/$metadata#TriggersCollection.TriggersCollection",
"@odata.id": "/redfish/v1/TelemetryService/Triggers",
"@odata.type": "#TriggersCollection.TriggersCollection",
"Name": "Triggers",
"Members@odata.count": 2,
"Members": [
{
"@odata.id": "/redfish/v1/TelemetryService/Triggers/CPUUsageTriggers"
},
{
"@odata.id": "/redfish/v1/TelemetryService/Triggers/MemoryUsageTriggers"
}
]
}

响应码:200

POST (CREATE) ​

命令功能

创建触发器

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

URL: https://device_ip/redfish/v1/TelemetryService/Triggers

请求头:

text
X-Auth-Token: auth_value
Content-Type: header_type

请求消息体:

json
{
"Id": id,
"Name": name,
"Description": description,
"Links": {
"MetricReportDefinitions": [
{
"@odata.id": metricreportdefinitions_value
}
]
},
"MetricIds": metricids_value,
"MetricType": metrictype_value,
"NumericThresholds": {
"LowerCritical": {
"Reading": lowercritical_reading_value,
"Activation": lowercritical_activation_value,
"DwellTime": lowercritical_dwelltime_value
},
"LowerWarning": {
"Reading": lowerwarning_reading_value,
"Activation": lowerwarning_activation_value,
"DwellTime": lowerwarning_dwelltime_value
},
"UpperCritical": {
"Reading": uppercritical_reading_value,
"Activation": uppercritical_activation_value,
"DwellTime": uppercritical_dwelltime_value
},
"UpperWarning": {
"Reading": upperwarning_reading_value,
"Activation": upperwarning_activation_value,
"DwellTime": upperwarning_dwelltime_value
}
},
"TriggerActions": triggeractions_value,
"TriggerEnabled": triggerenabled_value
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
id新建触发器Id字符串,只能由大小写字母、数字和下划线组成,长度为1-64
name新建触发器名称字符串,长度为1-64
description新建触发器描述可选,字符串,最长不超过128个字符
metricreportdefinitions_value触发器关联的指标报告定义可选,字符串
metricids_value触发器引用的指标项定义Id可选,字符串数组,字符串长度为1-64
metrictype_value触发器类型可选,字符串,支持:Numeric
lowercritical_reading_value低值严重告警门限值可选,数字
lowercritical_activation_value低值严重告警触发门限方向可选,字符串,支持:Increasing、Decreasing、Either、Disabled
lowercritical_dwelltime_value低值严重告警触发门限违反多长时间后触发器被激活可选,字符串
lowerwarning_reading_value低值一般告警门限值可选,数字
lowerwarning_activation_value低值一般告警触发门限方向可选,字符串,支持:Increasing、Decreasing、Either、Disabled
lowerwarning_dwelltime_value低值一般告警触发门限违反多长时间后触发器被激活可选,字符串
uppercritical_reading_value高值严重告警门限值可选,数字
uppercritical_activation_value高值严重告警触发门限方向可选,字符串,支持:Increasing、Decreasing、Either、Disabled
uppercritical_dwelltime_value高值严重告警触发门限违反多长时间后触发器被激活可选,字符串
upperwarning_reading_value高值一般告警门限值可选,数字
upperwarning_activation_value高值一般告警触发门限方向可选,字符串,支持:Increasing、Decreasing、Either、Disabled
upperwarning_dwelltime_value高值一般告警触发门限违反多长时间后触发器被激活可选,字符串
triggeractions_value触发器触发后的行为可选,数组,支持:RedfishEvent、RedfishMetricReport
triggerenabled_value触发器使能状态可选,布尔值

使用指南

无

使用实例

请求样例:

http
POST <https://device_ip/redfish/v1/TelemetryService/Triggers>

请求头:

text
X-Auth-Token: 123456789***********************
Content-Type: application/json

请求消息体:

json
{
"Id": "MemoryUsageTrigger",
"Name": "Memory Usage Trigger",
"Description": "Trigger for memory usage.",
"Links": {
"MetricReportDefinitions": [
{
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/MemoryUsageReport"
}
]
},
"MetricIds": [
"MemoryUsage"
],
"MetricType": "Numeric",
"NumericThresholds": {
"UpperCritical": {
"Reading": 50,
"Activation": "Increasing",
"DwellTime": "PT0.001S"
},
"UpperWarning": {
"Reading": 45.5,
"Activation": "Increasing",
"DwellTime": "PT0.004S"
}
},
"TriggerActions": [
"RedfishMetricReport"
],
"TriggerEnabled": true
}

响应样例:

json
{
"@odata.context": "/redfish/v1/$metadata#Triggers.v1_4_0.Triggers",
"@odata.id": "/redfish/v1/TelemetryService/Triggers/MemoryUsageTriggers",
"@odata.type": "#Triggers.v1_4_0.Triggers",
"Id": "MemoryUsageTrigger",
"Name": "Memory Usage Trigger",
"Description": "Trigger for memory usage.",
"Links": {
"MetricReportDefinitions": [
{
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/MemoryUsageReport"
}
]
},
"MetricIds": [
"MemoryUsage"
],
"MetricType": "Numeric",
"NumericThresholds": {
"LowerCritical": {
"Reading": 0,
"Activation": "Disabled",
"DwellTime": "PT0S"
},
"LowerWarning": {
"Reading": 0,
"Activation": "Disabled",
"DwellTime": "PT0S"
},
"UpperCritical": {
"Reading": 50,
"Activation": "Increasing",
"DwellTime": "PT0.001S"
},
"UpperWarning": {
"Reading": 45.5,
"Activation": "Increasing",
"DwellTime": "PT0.004S"
}
},
"TriggerActions": [
"RedfishMetricReport"
],
"TriggerEnabled": true
}

响应码:200