ResourceDefinition

uris

/redfish/v1/TelemetryService/MetricReportDefinitions

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	MetricDefinitions资源模型的OData描述信息
@odata.id	string	true	-	MetricDefinitions资源节点的访问路径
@odata.type	string	true	-	MetricDefinitions资源类型
Name	string	false	-	指标报告定义集合资源名称
Members	object	true	-	指标报告定义集合资源成员
Members@odata.count	number	true	-	指标报告定义集合资源成员总数

supported_methods

GET
POST

HTTP methods

GET

命令功能

查询指标报告定义资源信息

说明

BMC300 5.9.0.1及以上版本支持

命令格式

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

请求头:


X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

无

使用实例

请求样例：

http

GET https://device_ip/redfish/v1/TelemetryService/MetricReportDefinitions

请求头：


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

请求消息体：无

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#MetricReportDefinitionCollection.MetricReportDefinitionCollection",
  "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions",
  "@odata.type": "#MetricReportDefinitionCollection.MetricReportDefinitionCollection",
  "Name": "MetricReportDefinitions",
  "Members": [
    {
      "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/CPUUsageReport"
    },
    {
      "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/MemoryUsageReport"
    }
  ],
  "Members@odata.count": 2
}

响应码：200

POST (CREATE)

命令功能

创建指标报告定义资源信息

说明

BMC300 5.9.0.1及以上版本支持

命令格式

URL：https://device_ip/redfish/v1/TelemetryService/MetricReportDefinitions

请求头： X-Auth-Token: auth_value Content-Type: header_type

请求消息体：

json

{
  "Id": id,
  "Name": name,
  "Description": description,
  "MetricReportDefinitionEnabled": state,
  "MetricReportDefinitionType": type,
  "Metrics": [
    {
      "CollectionDuration": collectionduration_value,
      "CollectionFunction": collectionfunction_value,
      "CollectionTimeScope": collectiontimescope_value,
      "MetricId": metricid_value
    }
  ],
  "ReportActions": reportactions_value,
  "ReportUpdates": reportupdates_value,
  "Schedule": {
    "InitialStartTime": initialstarttime_value,
    "Lifetime": lifetime_value,
    "MaxOccurrences": maxoccurrences_value,
    "RecurrenceInterval": recurrenceinterval_value
  }
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
id	新建指标报告Id	字符串。只能由大小写字母、数字和下划线组成，长度为 1-64
name	新建指标报告名称	字符串。长度为1-64
description	新建指标报告描述	可选参数，字符串。最长不超过128个字符。
state	指标报告生成是否使能	可选参数，布尔值，默认为false。此属性控制是否产生新的指标报告。属性值为false 则不收集数据，包括触发器触发。
type	指定产生指标报告方式	可选参数，字符串，默认为Periodic. 支持的取值： ● OnChange：指标项取值变化时产生 ● OnRequest：查询指标报告时收集并生成 ● Periodic：周期性产生，如果选择这个方式，需要指定Schedule 属性用于指定生成周期
collectionduration_value	对原始指标项进行统计计算的时长	可选参数，字符串。格式如下：^P(\d+D)? (T(\d+H)?(\d+M)?(\d +(.\d+)?S)?)?$ 说明：如果配置了 CollectionDuration,则必须配置 RecurrenceInterval, 且 CollectionDuration必须大于RecurrenceInterval
collectionfunction_value	对MetricProperties中指定的原始指标项进行的计算算法	可选参数，字符串。支持的取值： ● Average：在 CollectionDuration时间范围内的平均值 ● Maximum：在 CollectionDuration时间范围内的最大值 ● Minimum：在 CollectionDuration时间范围内的最小值 ● Summation：在 CollectionDuration时间范围内的总和
collectiontimescope_valu e	计算算法的作用的时间范围	可选参数，字符串。支持的取值： ● Interval：周期性采集，通过 CollectionDuration指定采集周期，通过 MetricReport中 Timestamp属性记录每一次采集的时间 ● Point：指定某个时间点进行采集 ● StartupInterval：从距离采集资源启动后某个时间间隔进行采集，通过Timestamp指定实际执行的时间，通过 CollectionDuration指定距离启动的时间间隔
metricid_value	指标项的标识符	可选参数，字符串。长度为1-64. 如果指标报告使用的指标项是指标定义中定义的，此属性取值即为对应Metric的Id；如果是通过MetricProperties 定义的指标项，则此属性不应该存在。
reportactions_value	指标报告更新后的动作	可选参数，字符串数组，默认全选。允许同时选择多个，取值可以是： ● LogToMetricReportsC ollection：记录在对应指标报告资源中 ● RedfishEvent：通过 redfish事件上报给订阅者
reportupdates_value	指标报告容量达上限后的更新操作	可选参数，字符串，默认为 AppendWrapsWhenFull. 支持的取值： ● AppendWrapsWhenFu ll：新纪录覆盖旧记录
initialstarttime_value	指标报告首次出现的时间	可选参数，字符串，默认为 1970-01-01T00:00:00+00: 00. 字符串长度最长为32，格式如下： ^\d{4}-\d{1,2}-\ \d{1,2}T\d{1,2}:\d{1,2}:\ \d{1,2}.\d{1,2}:\d{1,2}$
lifetime_value	指标报告的生命周期	可选参数，字符串。字符串长度最长为256，格式如下： ^P(\d+D)?(T(\d+H)?(\ \d+M)?(\d+(.\d+)?S)?)? $
maxoccurrences_value	指标报告生成的最大次数	可选参数，整型。
recurrenceinterval_value	连续生成的指标报告间的时间间隔	可选参数，字符串，默认为PT10S. 字符串长度最长为256，格式如下： ^P(\d+D)?(T(\d+H)?(\ \d+M)?(\d+(.\d+)?S)?)? $

使用指南

无

使用实例

请求样例：

POST https://device_ip/redfish/v1/TelemetryService/MetricReportDefinitions

请求头：

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

请求消息体：

json

{
  "Id": "MemoryUsageReport",
  "Name": "Metric report of Memory Usage",
  "Description": "Metric report of Memory Usage",
  "MetricReportDefinitionEnabled": false,
  "MetricReportDefinitionType": "Periodic",
  "Metrics": [
    {
      "CollectionDuration": "PT1H",
      "CollectionFunction": "Average",
      "CollectionTimeScope": "Interval",
      "MetricId": "MemoryUsage"
    }
  ],
  "ReportActions": [
    "LogToMetricReportsCollection",
    "RedfishEvent"
  ],
  "ReportUpdates": "AppendWrapsWhenFull",
  "Schedule": {
    "InitialStartTime": "2025-05-01T00:00:00+00:00",
    "RecurrenceInterval": "PT5M"
  }
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#MetricReportDefinition.MetricReportDefinition",
  "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/MemoryUsageReport",
  "@odata.type": "#MetricReportDefinition.v1_4_6.MetricReportDefinition",
  "Id": "MemoryUsageReport",
  "Name": "Metric report of Memory Usage",
  "AppendLimit": 128,
  "Description": "Metric report of Memory Usage",
  "MetricReport": {
    "@odata.id": "/redfish/v1/TelemetryService/MetricReports/MemoryUsageReport"
  },
  "MetricReportDefinitionEnabled": false,
  "MetricReportDefinitionType": "Periodic",
  "Metrics": [
    {
      "CollectionDuration": "PT1H",
      "CollectionFunction": "Average",
      "CollectionTimeScope": "Interval",
      "MetricId": "MemoryUsage"
    }
  ],
  "ReportActions": [
    "LogToMetricReportsCollection",
    "RedfishEvent"
  ],
  "ReportUpdates": "AppendWrapsWhenFull",
  "Schedule": {
    "InitialStartTime": "2025-05-01T00:00:00+00:00",
    "RecurrenceInterval": "PT5M"
  },
  "Status": {
    "Health": "OK",
    "State": "Enabled"
  },
  "Links": {
    "Triggers": [
      {
        "@odata.id": "/redfish/v1/TelemetryService/Triggers/MemoryUsageTriggers"
      }
    ]
  }
}

响应码：201

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

POST (CREATE) ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

POST (CREATE)