Health Management User Manual

Document Version	Content Revision	Reviser	Revision Date
V1.0	Draft	Guochenghao	2023-10-07

Table of Contents

• Table of Contents
• 1: Report Fault

1: Report Fault

Interface URL: POST http://127.0.0.1:3467/management/api/v1/health/device/status

Content-Type: application/json

Authentication Method: Bearer auth

• Body Request Parameters

{
    "time": 1693883441407, // Report timestamp
    "deviceId": "ae06f8e7-10fa-4131-be73-cec81c0a7045", // Device ID
    "name": "Splicer 1", // Device Name
    "model": "cysvc-cs", // Type
    "modelName": "cysvc-cs", // Type Name
    "assetType": "MCNet-5EP0-1J-4KH", // Model
    "assetTypeName": "MCNet-5EP0-1J-4KH", // Model Name
    "nailHeight": 3, // Number of nails occupying the cabinet
    "width": 0.5, // Device width (unit: meters)
    "height": 0.4, // Device height (unit: meters)
    "deep": 0.3, // Device depth (unit: meters)
    "status": {
        "status": "abnormal", // Overall device status: normal/warning/abnormal/unknown
        "message": "设备出现1个端口故障", // Status description
        "status_code": 1002, // Status code
        "online_time": 0 // Online duration
    },
    "layout": [
        // Panel Status
        {
            "direction": "BACK", // Panel position: UP/DOWN/LEFT/RIGHT/FRONT/BACK
            "serialInterfaces": [
                {
                    "type": "HDMI", // Serial port type
                    "index": 1, // Serial port type
                    "nodeIp": "", // Serial port type
                    "nodeType": "INPUT", // Input/Output type: INPUT/OUTPUT
                    "bindPort": 1,
                    "expect": true, // Whether expected
                    "direction": "DOWN", // Serial port direction
                    "usage": "",
                    "status": {
                        "status": "normal", // Serial port status
                        "message": "Signal online, fiber connected",
                        "status_code": 1000, // Status code
                        "online_time": 0 // Online duration
                    }
                }
            ]
        }
    ]
}

• Response Example

{
   "code": 0, //Return code
   "data": "", //-
   "msg": "success" //Error message
}