ResourceDefinition

uris

/redfish/v1/TelemetryService/MetricDefinitions/{id}

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	MetricDefinitions资源模型的OData描述信息
@odata.id	string	true	-	MetricDefinitions资源节点的访问路径
@odata.type	string	true	-	MetricDefinitions资源类型
Id	string	true	-	指标定义Id
Name	string	true	-	指标定义名称
Description	string	true	-	指标定义描述
Accuracy	number	true	-	指标精度，单位：%
Calculable	string	true	NonCalculable, NonSummable, Summable	指标可计算性 ● NonCalculable：不可计算 ● NonSummable：不可求和 ● Summable：可求和
CalculationAlgorithm	string	true	Average, Maximum, Minimum	对原始指标值进行的计算算法 ● Average：求均值 ● Maximum：求最大值 ● Minimum：求最小值
CalculationParameters	array	true	-	用于计算目标指标值所需要的指标项说明：这些指标项必须在MetricProperties数组中被定义，如果ImplementationType取值为Synthesized或Calculated，则必须给出此属性
ResultMetric	string	true	-	存储计算结果的指标属性，格式为带有通配符和属性定义的URI
SourceMetric	string	true	-	作为计算输入的指标属性，格式为带有通配符和属性定义的URI
CalculationTimeInterval	string	true	^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$	对原始指标项进行计算的时间间隔
Calibration	number	true	-	指标值的校准偏移量，对离散型指标项无效目标值=Calibration + 原始值
DiscreteValues	array	true	-	指定离散型指标值的离散取值
Implementation	string	true	Calculated, DigitalMeter, PhysicalSensor, Synthesized	指标项获取方法 ● Calculated：通过另一个metricproperty计算得到 ● DigitalMeter：数值型，例如计数 ● PhysicalSensor：来自物理传感器 ● Synthesized：合成型，由多个metricproperties计算得到
IsLinear	boolean	true	true, false	指标项取值是否为线性值
LogicalContexts	array	true	Capacity, Environment, Network, Performance, Security, Storage	指标项关联的业务类型 ● Capacity：容量 ● Environment：环境 ● Network：网络 ● Performance：性能 ● Security：安全 ● Storage：存储
MaxReadingRange	number	true	-	指标项最大读值，对离散采集项无意义
MetricDataType	string	true	Boolean, DateTime, Decimal, Enumeration, Integer, String	指标项数据类型 ● Boolean：布尔值 ● DateTime：时间戳 ● Decimal：十进制值 ● Enumeration：枚举值 ● Integer：整型 ● String：字符串
MetricProperties	array	true	-	指标项数据来源取值是由URI构成的数组，如果包含通配符，需要有配套的Wildcards属性
MetricType	string	true	Countdown, Counter, Discrete, Gauge, Numeric, String	指标项类型 ● Countdown：倒计数 ● Counter：计数 ● Discrete：离散 ● Gauge：实数类型，但是有上下界，达到上下界时取值保持不变 ● Numeric: 实数 ● String：字符串
MinReadingRange	number	true	-	指标项最小读值
PhysicalContext	string	true	详见说明	采集项的物理含义，取值包括Room、Intake、Exhaust、LiquidInlet、LiquidOutlet、Front、Back、Upper、Lower、CPU、CPUSubsystem、GPU、GPUSubsystem、FPGA、Accelerator、ASIC、Backplane、SystemBoard、PowerSupply、PowerSubsystem、VoltageRegulator、Rectifier、StorageDevice、StorageSubsystem、NetworkingDevice、ExpansionSubsystem、ComputeBay、StorageBay、NetworkBay、ExpansionBay、PowerSupplyBay、Memory、MemorySubsystem、Chassis、Fan、CoolingSubsystem、Motor、Transformer、ACUtilityInput、ACStaticBypassInput、ACMaintenanceBypassInput、DCBus、ACOutput、ACIutput、PowerOutlet
Precision	int	true	-	指标项采样精度，对离散型采集项无意义
SensingInterval	string	true	^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$	采集项数据刷新时间（指原始值变化一次的时间，取决于具体指标项获取的能力和方式，telemetry去采集数据时周期不应该大于这个时间，否则没有意义）
TimestampAccuracy	string	true	^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$	时间精度
Units	string	true	-	指标项的度量单位
Wildcards	array	true	-	MetricProperties中定义的通配取值说明

supported_methods

HTTP methods

GET

命令功能

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

说明

BMC300 5.9.0.1及以上版本支持

命令格式

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

请求头:


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/MetricDefinitions/FANTemperature

请求头：


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

请求消息体：无

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#MetricDefinition.MetricDefinition",
  "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/FANTemperature",
  "@odata.type": "#MetricDefinition.v1_3_4.MetricDefinition",
  "Id": "FANTemperature",
  "Name": "MetricDefinitionName",
  "Description": "Metric Definition",
  "Accuracy": 1,
  "Calculable": "Summable",
  "CalculationAlgorithm": "Average",
  "CalculationParameters": [
    {
      "ResultMetric": "/redfish/v1/Chassis/{ChassisId}/Thermal#/Temperatures/{TemperaturesId}",
      "SourceMetric": "/redfish/v1/Chassis/{ChassisId}/Thermal#/Temperatures"
    }
  ],
  "CalculationTimeInterval": "PT5S",
  "Calibration": null,
  "DiscreteValues": null,
  "Implementation": "PhysicalSensor",
  "IsLinear": true,
  "LogicalContexts": [
    "Environment"
  ],
  "MaxReadingRange": null,
  "MetricDataType": "Decimal",
  "MetricProperties": [
    {
      "@odata.id": "/redfish/v1/Chassis/{ChassisId}/Thermal#Oem/Baidu/FanSpeedLevelPercents"
    }
  ],
  "MetricType": "Numeric",
  "MinReadingRange": null,
  "PhysicalContext": "Fan",
  "Precision": null,
  "SensingInterval": "PT3S",
  "TimestampAccuracy": "",
  "Units": "C",
  "Wildcards": [
    {
      "Name": "ChassisId",
      "Values": [
        "1"
      ]
    },
    {
      "Name": "TemperaturesId",
      "Values": [
        "1",
        "2",
        "3"
      ]
    }
  ]
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET