Updated on 2025-03-31 GMT+08:00

Health Check Interface

Description

This interface is invoked by third-party access systems to check whether the ODFS is running properly. Response code 200 indicates that the ODFS is running properly.

Interface Method

POST or GET

URL

https://IP:PORT/oifde/rest/api/servicemonitor

Request

Table 1 Parameter in the request header

No.

Parameter

Type

Mandatory

Description

1

Content-Type

String

Yes

The value is fixed at application/json; charset=UTF-8.

Response

  • Status code: 200
    Table 2 Parameter in the response body

    No.

    Parameter

    Type

    Description

    1

    jvm

    Object

    JVM health metric object.

    Table 3 Parameters in the response body

    No.

    Parameter

    Type

    Description

    1

    fullgc

    String

    Full GC check status. The value 0 indicates that the check is successful, and other values indicate that the check fails.

    2

    deadload

    String

    Deadload check status. The value 0 indicates that the check is successful, and other values indicate that the check fails.

  • Status code: 400

    The current server status is abnormal.

Message Example

  • Request

    None

  • Response
    {
      "jvm": {
        "fullgc": "0",
        "deadlock": "0"
    }