代码仓
中
ContaminationDetection
更新时间： 2026/10/29
在AtomGit上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-脏污检测接口集合资源模型的OData描述信息
@odata.idstringtrue-脏污检测接口集合资源的访问路径
@odata.typestringtrue-脏污检测接口集合资源的类型
Actions {objecttrue-脏污检测接口集合组密钥导入操作
Actions.#ContaminationDetection.GetResult {objecttrue-获取检测结果操作
Actions.#ContaminationDetection.GetResult.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#ContaminationDetection.GetResult.targetstringtrue-操作路径
}
Actions.#ContaminationDetection.Initiate {objecttrue-发起污染检测操作
Actions.#ContaminationDetection.Initiate.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#ContaminationDetection.Initiate.targetstringtrue-操作路径
}
Actions.#ContaminationDetection.Shutdown {objecttrue-停止污染检测操作
Actions.#ContaminationDetection.Shutdown.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#ContaminationDetection.Shutdown.targetstringtrue-操作路径
}
Actions.#ContaminationDetection.Start {objecttrue-启动污染检测操作
Actions.#ContaminationDetection.Start.@Redfish.ActionInfostringtrue-操作信息查询路径
Actions.#ContaminationDetection.Start.targetstringtrue-操作路径
}
}
Detectors {objecttrue-污染检测传感器信息
Detectors.@odata.idstringtrue-Detectors资源的访问路径
}
Idstringtrue-脏污检测接口集合资源ID
Namestringtrue-脏污检测接口集合资源名称
Actionobjecttrue-脏污检测接口集合资源

supported_methods ​

  • GET
  • POST

HTTP methods ​

GET ​

命令功能

查询脏污检测接口集合的资源信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection

请求头:

text
X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

按照以下步骤，创建光模块脏污检测：

  1. 初始化服务器脏污检测，服务器配置请参阅初始化脏污检测。
  2. 启动服务器脏污检测，服务器配置请参阅启动脏污检测。
  3. 等待一定的测试时间。
  4. 查询服务器脏污检测信息，服务器配置请参阅查询脏污检测信息。
  5. 终止服务器脏污检测，服务器配置请参阅终止脏污检测。

使用实例

请求样例： GET https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection

X-Auth-Token: auth_value 请求消息体：无

响应样例：

json
{
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/ContaminationDetection",
"@odata.type": "#HwContaminationDetection.v1_0_0.HwContaminationDetection",
"@odata.context": "/redfish/v1/$metadata#HwContaminationDetection.HwContaminationDetection",
"Id": "ContaminationDetection",
"Name": "Contamination Detection",
"Detectors": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/ContaminationDetection/Detectors"
},
"Actions": {
"#ContaminationDetection.GetResult": {
"target": "/redfish/v1/Managers/1/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.GetResult",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/DiagnosticService/ContaminationDetection/GetResultActionInfo"
},
"#ContaminationDetection.Initiate": {
"target": "/redfish/v1/Managers/1/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.Initiate",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/DiagnosticService/ContaminationDetection/InitiateActionInfo"
},
"#ContaminationDetection.Start": {
"target": "/redfish/v1/Managers/1/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.Start",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/DiagnosticService/ContaminationDetection/StartActionInfo"
},
"#ContaminationDetection.Shutdown": {
"target": "/redfish/v1/Managers/1/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.Shutdown",
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/DiagnosticService/ContaminationDetection/ShutdownActionInfo"
}
}
}

响应码：200

POST (ACTION) ​

GetResult ​

命令功能

查询脏污检测信息

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.GetResult

请求头:

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

请求消息体:

json
{
"Detectors": []
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
Detectors脏污检测的对象测试对象序列号列表说明目前最多支持8个脏污检测对象

使用指南

无

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.GetResult

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json
{
"Detectors": []
}

响应样例：

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",
"Oem": {
"Public": {
"Detections": [
{
"DetectorId": "300001",
"DetectionPhase": "Phase2",
"DetectionStatus": "Completed",
"Result": {
"ContaminationDetected": "Detected",
"LocalContaminationDetected": "Detected",
"RemoteContaminationDetected": "Detected",
"FirstContaminationDistance": [
10. 0,
-1,
…
],
"SecondContaminationDistance": [
-1,
-1,
…
]
}
},
{
"DetectorId": "300002",
"DetectionPhase": "Phase2",
"DetectionStatus": "Completed",
"Result": {
"ContaminationDetected": "NotDetected",
"LocalContaminationDetected": "NotDetected",
"RemoteContaminationDetected": "NotDetected",
"FirstContaminationDistance": [
-1,
-1,
…
],
"SecondContaminationDistance": [
-1,
-1,
…
]
}
}
]
}
}
}
]
}
}

响应码：200

POST (ACTION) ​

Initiate ​

命令功能

初始化脏污检测

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.Initiate

请求头:

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

请求消息体:

json
{
"Configuration": [
{
"DetectorId": "",
"DurationSeconds":
}
]
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
DetectorId脏污检测对象序列号可通过/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection/Detectors获得
DurationSeconds脏污检测超时时间超时后脏污检测自动终止数字（单位：s）。取值范围60 - 900

使用指南

脏污检测会导致正常业务流不通，需要在无业务的情况下执行

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.Initiate

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json
{
"Configuration": [
{
"DetectorId": "",
"DurationSeconds":
}
]
}

响应样例：

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",
"Oem": {
"Public": {
"OperationResults": [
{
"Result": "Success",
"DetectorId": "300001"
}
]
}
}
}
]
}
}

响应码：200

POST (ACTION) ​

Start ​

命令功能

启动脏污检测

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.Start

请求头:

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

请求消息体:

json
{
"Detectors": [
"30001"
],
"Operation": "InitiationPhase1"
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
Detectors脏污检测的对象检测对象序列号列表
说明：目前最多支持8个脏污检测对象
Operation要启动的检测操作取值InitiationPhase1，
DetectionPhase1,
InitiationPhase2,
DetectionPhase2

使用指南

脏污检测会导致正常业务流不通，需要在无业务的情况下执行

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.Start

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json
{
"Detectors": [
"30001"
],
"Operation": "InitiationPhase1"
}

响应样例：

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",
"Oem": {
"Public": {
"OperationResults": [
{
"Result": "Success",
"DetectorId": "300001"
}
]
}
}
}
]
}
}

响应码：200

POST (ACTION) ​

Shutdown ​

命令功能

终止脏污检测

命令格式

URL: https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.Shutdown

请求头:

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

请求消息体:

json
{
"Detectors": []
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
Detectors脏污检测的对象检测对象序列号列表说明目前最多支持8个脏污检测对象

使用指南

脏污检测会导致正常业务流不通，需要在无业务的情况下执行

使用实例

请求样例： POST https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/ContaminationDetection/Actions/ContaminationDetection.Shutdown

X-Auth-Token: auth_value Content-Type: header_type 请求消息体：

json
{
"Detectors": []
}

响应样例：

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",
"Oem": {
"Public": {
"OperationResults": [
{
"Result": "Success",
"DetectorId": "300001"
}
]
}
}
}
]
}
}

响应码：200

下一篇探索openUBMC