Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Checking Cluster Health Status
Updated on 2023-12-19 GMT+08:00
View PDF
Share

Checking Cluster Health Status

Description

This interface is invoked by a third-party system to check whether the CC-CMS runs properly.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

URL

https://ip:port/rest/cmsapp/v1/ping

In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.In a non–public cloud environment where the NSLB service is configured, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.

Request Description

Table 1 Parameters in the request header

No.

Parameter

Type

Mandatory

Description

1

Content-Type

String

True

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

2

Authorization

String

True

For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.
Table 2 Parameters in the message body

Parameter

Type

Mandatory

Description

say (can be modified)

Object

True

Request packet. The code does not process the packet and writes it back to the response message body.

Response Description

Table 3 If the response code is 200, it indicates that the CMS runs properly. The following table describes the parameters in the response message.

Parameter

Type

Description

status

String

If the response is successful, UP is returned.

request

Object

Input parameter object returned when the response is successful.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters 
    {
"say": "Hello world!"
}
  • Response parameters 
    {
"request": {
"say": "Hello world!"
},
"status": "UP"
}