ResourceDefinition

uris

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

properties

名称	类型	是否只读	说明
@odata.context	string	true	脏污检测接口集合资源模型的OData描述信息
@odata.id	string	true	脏污检测接口集合资源的访问路径
@odata.type	string	true	脏污检测接口集合资源的类型
Id	string	true	脏污检测接口集合资源ID
Name	string	true	脏污检测接口集合资源名称
target	string	true	脏污检测查询接口的访问路径
@Redfish.ActionInfo	string	true	脏污检测查询接口说明的访问路径
MessageId	string	true	消息ID
RelatedProperties	array	true	消息相关属性
Message	string	true	详细信息
MessageArgs	array	true	信息参数
Severity	string	true	严重性Redfish支持的严重级别包括：OK、Warning、Critical
Resolution	string	true	解决建议
Detections	array	true	脏污检测对象信息列表
DetectionPhase	string	true	脏污检测对象所处阶段取值范围 None Phase1 Phase2
DetectionStatus	string	true	脏污检测对象所处状态取值范围 Pending:阶段未启动 Running:阶段正在进行 Completed:阶段已完成 Unknown:状态无法确定
DetectorId	string	false	脏污检测对象序列号
ContaminationDetected	string	true	检测结论取值范围 Detected:脏污 NotDetected:没有脏污 Unknown:未知
LocalContaminationDetected	string	true	本端Rx光口脏污检测结果 Detected:脏污 NotDetected:没有脏污 Unknown:未知
RemoteContaminationDetected	string	true	对端Tx光口脏污检测结果 Detected:脏污 NotDetected:没有脏污 Unknown:未知
FirstContaminationDistance	array	true	各通道最大脏污点与本端光模块之间的距离，单位米
SecondContaminationDistance	array	true	各通道第二大脏污点与本端光模块之间的距离，单位米
OperationResults	array	true	初始化脏污检测的返回信息
Result	string	true	初始化脏污检测的结果取值范围 Success:成功 Failed:失败
Operation	string	false	要启动的检测操作取值 InitiationPhase1， DetectionPhase1, InitiationPhase2, DetectionPhase2

supported_methods

GET
POST

HTTP methods

GET

命令功能

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

命令格式

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

请求头:

X-Auth-Token: auth_value

请求消息体: 无

参数说明

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

使用指南

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

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

使用实例

请求样例： 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

请求头:

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

请求头:

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

请求头:

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

请求头:

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

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

POST (ACTION) ​

GetResult ​

POST (ACTION) ​

Initiate ​

POST (ACTION) ​

Start ​

POST (ACTION) ​

Shutdown ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

POST (ACTION)

GetResult

POST (ACTION)

Initiate

POST (ACTION)

Start

POST (ACTION)

Shutdown