Help Center/ Customer Engagement Center/ API Reference/ Monitoring Interface Reference/ Interface Description/ Interface for Uploading Logs
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Interface for Uploading Logs

Description

After the IP address and port number of the NSLB are configured on the OpenEye, an HTTPS interface of the CMS can be invoked to upload logs for fault information collection.

Interface Method

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

URL

https://ip:port/rest/${service.name}/v1/ClientLog/uploadClientLog

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

Yes

The value is fixed at multipart/form-data; boundary=<calculated when="" request="" is="" sent="">.

2

Authorization

String

True

For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.

3

FileType

String

True

File type. Currently, only 0 is supported.
Table 2 Parameters in the message body

Parameter

Type

Mandatory

Description

file

MultipartFile

True

Request packet, including log file content and file names.

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, 200 is returned.

Message Example

  • Request header 
    Content-Type:multipart/form-data; boundary=--------------------------327397481665620642032364
Authorization:******************
FileType:0
  • Request parameters 
    {
"file": OELOG_99991093_10.234.63.214_20250226162127.zip
}
  • Response parameters 
    None
Parent topic: Interface Description