ResourceDefinition

uris

/redfish/v1/TelemetryService/Triggers/{id}

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	Triggers资源模型的OData描述信息
@odata.id	string	true	-	Triggers资源节点的访问路径
@odata.type	string	true	-	Triggers资源类型
Id	string	true	-	触发器Id
Name	string	true	-	触发器名称
Description	string	true	-	触发器描述
Links {	object	false	-	关联的指标报告定义资源链接
Links.MetricReportDefinitions [ {	array	false	-	触发器关联的指标报告定义，可关联多个，即引用该触发器的指标报告定义链接
`Links.MetricReportDefinitions[].@odata.id`	string	true	-	成员资源节点的访问路径
} ]
}
MetricIds[ ]	array	false	-	触发器引用的指标项定义Id
MetricType	string	true	Numeric	触发器类型 ● Numeric：连续值触发器
NumericThresholds {	object	false	-	触发离散事件的门限定义
NumericThresholds.LowerCritical {	object	false	-	低值严重告警门限
NumericThresholds.LowerCritical.Reading	number	false	-	门限值
NumericThresholds.LowerCritical.Activation	string	false	Increasing,Decreasing,Either,Disabled	触发门限方向 ● Increasing：读值增加至高于门限值 ● Decreasing：读值减少至低于门限值 ● Either：读值在任一方向上越过门限值 ● Disabled：禁用门限值
NumericThresholds.LowerCritical.DwellTime	string	false	^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$	指标值必须违反门限值多长时间后才会被激活
}
NumericThresholds.LowerWarning {	object	false	-	低值一般告警门限
NumericThresholds.LowerWarning.Activation	string	false	Increasing,Decreasing,Either,Disabled	触发门限方向 ● Increasing：读值增加至高于门限值 ● Decreasing：读值减少至低于门限值 ● Either：读值在任一方向上越过门限值 ● Disabled：禁用门限值
NumericThresholds.LowerWarning.DwellTime	string	false	^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$	指标值必须违反门限值多长时间后才会被激活
NumericThresholds.LowerWarning.Reading	number	false	-	门限值
}
NumericThresholds.UpperCritical {	object	false	-	高值严重告警门限
NumericThresholds.UpperCritical.Activation	string	false	Increasing,Decreasing,Either,Disabled	触发门限方向 ● Increasing：读值增加至高于门限值 ● Decreasing：读值减少至低于门限值 ● Either：读值在任一方向上越过门限值 ● Disabled：禁用门限值
NumericThresholds.UpperCritical.DwellTime	string	false	^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$	指标值必须违反门限值多长时间后才会被激活
NumericThresholds.UpperCritical.Reading	number	false	-	门限值
}
NumericThresholds.UpperWarning {	object	false	-	高值一般告警门限
NumericThresholds.UpperWarning.Activation	string	false	Increasing,Decreasing,Either,Disabled	触发门限方向 ● Increasing：读值增加至高于门限值 ● Decreasing：读值减少至低于门限值 ● Either：读值在任一方向上越过门限值 ● Disabled：禁用门限值
NumericThresholds.UpperWarning.DwellTime	string	false	^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$	指标值必须违反门限值多长时间后才会被激活
NumericThresholds.UpperWarning.Reading	number	false	-	门限值
}
}
TriggerActions[ ]	array	true	RedfishEvent,RedfishMetricReport	触发器触发后的行为 ● RedfishEvent：发送redfish事件 ● RedfishMetricReport：更新关联的指标报告，不受指标报告定义刷新时间与周期限制
TriggerEnabled	boolean	true	true,false	触发器使能状态

supported_methods

GET
PATCH
DELETE

HTTP methods

GET

命令功能

查询指定触发器资源信息

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

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

请求头:

text


X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

无

使用实例

请求样例：

http

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

请求头：

text


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

请求消息体：无

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#Triggers.v1_4_0.Triggers",
"@odata.id": "/redfish/v1/TelemetryService/Triggers/CPUUsageTriggers",
"@odata.type": "#Triggers.v1_4_0.Triggers",
"Id": "CPUUsageTriggers",
"Description": "Triggers for CPU Usage",
"Name": "Triggers for CPU Usage",
"Links": {
"MetricReportDefinitions": [
{
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/CPUUsageReport"
}
]
},
"MetricIds": [
"CPUUsage"
],
"MetricType": "Numeric",
"NumericThresholds": {
"LowerCritical": {
"Reading": 0,
"Activation": "Disabled",
"DwellTime": "PT0S"
},
"LowerWarning": {
"Reading": 0,
"Activation": "Disabled",
"DwellTime": "PT0S"
},
"UpperCritical": {
"Reading": 0,
"Activation": "Disabled",
"DwellTime": "PT0S"
},
"UpperWarning": {
"Reading": 100,
"Activation": "Increasing",
"DwellTime": "PT0S"
}
},
"TriggerActions": [
"RedfishMetricReport",
"RedfishEvent"
],
"TriggerEnabled": false
}

响应码：200

PATCH

命令功能

修改指定触发器资源信息

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

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

请求头:

text


X-Auth-Token: auth_value
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json

{
"Links": {
"MetricReportDefinitions": [
{
"@odata.id": metricreportdefinitions_value
}
]
},
"MetricIds": metricids_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
}
}
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
@odata.id	触发器关联的指标报告定义	字符串
MetricIds	触发器引用的指标项定义Id	字符串数组，字符串长度为1-64
Reading	低值严重告警门限值	数字
Activation	低值严重告警触发门限方向	字符串，支持：Increasing、Decreasing、Either、Disabled
DwellTime	低值严重告警触发门限违反多长时间后触发器被激活	字符串
Reading	低值一般告警门限值	数字
Activation	低值一般告警触发门限方向	字符串，支持：Increasing、Decreasing、Either、Disabled
DwellTime	低值一般告警触发门限违反多长时间后触发器被激活	字符串
Reading	高值严重告警门限值	数字
Activation	高值严重告警触发门限方向	字符串，支持：Increasing、Decreasing、Either、Disabled
DwellTime	高值严重告警触发门限违反多长时间后触发器被激活	字符串
Reading	高值一般告警门限值	数字
Activation	高值一般告警触发门限方向	字符串，支持：Increasing、Decreasing、Either、Disabled
DwellTime	高值一般告警触发门限违反多长时间后触发器被激活	字符串

使用指南

无

使用实例

请求样例：

http

PATCH <https://device_ip/redfish/v1/TelemetryService/Triggers/MemoryUsageTrigger>

请求头：

text


X-Auth-Token: 4b9d8666c671a55def97bf146b727dac
Content-Type: application/json
If-Match: W/"97a6c116"

请求消息体：

json

{
"NumericThresholds": {
"UpperWarning": {
"Reading": 46
}
}
}

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#Triggers.v1_4_0.Triggers",
"@odata.id": "/redfish/v1/TelemetryService/Triggers/MemoryUsageTrigger",
"@odata.type": "#Triggers.v1_4_0.Triggers",
"Id": "MemoryUsageTrigger",
"Description": "Trigger for memory usage.",
"Name": "Memory Usage Trigger",
"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": 46,
"Activation": "Increasing",
"DwellTime": "PT0.004S"
}
},
"TriggerActions": [
"RedfishMetricReport"
],
"TriggerEnabled": true
}

响应码：201

DELETE

命令功能

删除指定触发器

说明

openUBMC 25.12 LTS及以上版本支持

命令格式

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

请求头:

text


X-Auth-Token: auth_value

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
id	触发器id	用户可通过查询触发器列表获得
auth_value	请求消息的鉴权参数	可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例：

http

DELETE <https://device_ip/redfish/v1/TelemetryService/Triggers/CPUUsageTriggers>

请求头：

text


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

请求消息体：无

响应样例：

json

{
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_0_0.Message",
"MessageId": "Base.1.0.Success",
"RelatedProperties": [],
"Message": "Successfully Completed Request",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None"
}
]
}
}

响应码：200

输出说明

参见 DELETE 通用输出说明

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

DELETE ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

DELETE