Health Check

Function

Checks the service status. If the service is normal, the status code 200 is returned and the message body contains no content.

• This API is scheduled for deprecation.
• It is recommended that you call this API at 5-second intervals.

Format

Operation type: GET

URL: https://{ip}:{port}/v2/health/live

URL: https://{ip}:{port}/v2/health/ready

URL: https://{ip}:{port}/v2/models/${MODEL_NAME}[/versions/${MODEL_VERSION}]/ready

• The {ip} field preferentially reads the environment variable MIES_CONTAINER_MANAGEMENT_IP. If the environment variable does not exist, managementIpAddress in the configuration file is used. If managementIpAddress does not exist in the configuration file, ipAddress in the configuration file is used.
• The {port} field preferentially reads the managementPort parameter in the configuration file. If the configuration file does not contain the managementPort parameter, the port parameter in the configuration file is used.
• The ${MODEL_NAME} field specifies the name of the model to be queried.
• The [/versions/${MODEL_VERSION}] field is not supported currently and is not passed.

Request Parameters

None

Usage Example

Request example 1:

GET https://{ip}:{port}/v2/health/live
GET https://{ip}:{port}/v2/models/llama3-70b/ready

Response example 1:

• Normal service status

  None

• Secondary node exception

  {
      "message": no contact node detected,
      "no_contact_node": ["node(10.10.10.10) is no contact"]
  }

Output Description

• Status code 200: The service status is normal, and the message body contains no content.
• Other status codes: The service status is abnormal.