Help Center/ IoT Device Access/ API Reference/ MQTT or MQTTS API Reference on the Device Side/ Device Security Situational Awareness/ Device Reporting Security Situational Awareness Alarms
Updated on 2025-04-22 GMT+08:00
View PDF
Share

Device Reporting Security Situational Awareness Alarms

Topic

Upstream: $oc/devices/{device_id}/sys/events/up

Parameters

Parameter

Mandatory

Type

Description

services

No

List<ServiceEvent>

Explanation:

List of services that an event is about.

ServiceEvent structure

Parameter

Mandatory

Type

Description

service_id

Yes

String

Explanation:

System field.

Value range:

This value is fixed at $log.

event_type

Yes

String

Explanation:

System field.

Value range:

The value is fixed at security_log_report.

event_time

No

String

Explanation:

Event time. UTC time format: yyyyMMdd'T'HHmmss'Z'.

If this parameter is not carried in the reported data or is in incorrect format, the time when the platform receives the data is used.

paras

Yes

Object

Explanation:

Content of the device security check alarm.

paras structure

Parameter

Mandatory

Type

Description

timestamp

No

String

Explanation:

Time when a log is generated.

type

Yes

String

Explanation:

Security check type.

Value range:

MEMORY_REPORT: device memory reporting

PORT_REPORT: device port reporting

CPU_USAGE_REPORT: device CPU usage reporting

DISK_SPACE_REPORT: device disk size reporting

BATTERY_REPORT: device battery level reporting

LOGIN_LOCAL_REPORT: device local login reporting

IP_REPORT: device malicious IP address reporting

LOGIN_BRUTE_FORCE_REPORT: device brute-force login reporting

FILE_TAMPER_REPORT: device file tampering reporting

content

Yes

Object

Explanation:

Details about the reported data.

Parameters of content when type is set to MEMORY_REPORT

Parameter

Mandatory

Type

Description

used

Yes

List<Integer>

Explanation:

Used memory size.

total

Yes

Integer

Explanation:

Total memory size.

leak_alarm

Yes

Integer

Explanation:

Whether to report an alarm. Options: 0 (no) and 1 (yes).

Parameters of content when type is set to PORT_REPORT

Parameter

Mandatory

Type

Description

used

Yes

Integer

Explanation:

List of used ports.

Parameters of content when type is set to CPU_USAGE_REPORT

Parameter

Mandatory

Type

Description

cpu_usage

Yes

Integer

Explanation:

CPU usage.

cpu_usage_alarm

Yes

Integer

Explanation:

Whether to report an alarm. Options: 0 (no) and 1 (yes).

Parameters of content when type is set to DISK_SPACE_REPORT

Parameter

Mandatory

Type

Description

disk_space_used

Yes

Integer

Explanation:

Used disk size.

disk_space_total

Yes

Integer

Explanation:

Total disk size.

disk_space_alarm

Yes

Integer

Explanation:

Whether to report an alarm. Options: 0 (no) and 1 (yes).

Parameters of content when type is set to BATTERY_REPORT

Parameter

Mandatory

Type

Description

battery_percentage

Yes

Integer

Explanation:

Current battery level.

battery_percentage_alarm

Yes

Integer

Explanation:

Whether to report an alarm. Options: 0 (no) and 1 (yes).

Parameters of content when type is set to LOGIN_LOCAL_REPORT

Parameter

Mandatory

Type

Description

login_local_alarm

Yes

Integer

Explanation:

Whether to report an alarm. Options: 0 (no) and 1 (yes).

Parameters of content when type is set to IP_REPORT

Parameter

Mandatory

Type

Description

usedIps

Yes

List<String>

Explanation:

List of used IP addresses.

Parameters of content when type is set to LOGIN_BRUTE_FORCE_REPORT

Parameter

Mandatory

Type

Description

login_brute_force_alarm

Yes

Integer

Explanation:

Whether to report an alarm. Options: 0 (no) and 1 (yes).

Parameters of content when type is set to FILE_TAMPER_REPORT

Parameter

Mandatory

Type

Description

file_tamper_alarm

Yes

Integer

Explanation:

Whether to report an alarm. Options: 0 (no) and 1 (yes).

Example

Topic: $oc/devices/{device_id}/sys/events/up   
Data format:
{
	"services": [{
		"service_id": "$log",
		"event_type": "security_log_report",
		"event_time": "20151212T121212Z",
		"paras": {
			"type": "MEMORY_REPORT",
			"content": {
				"used": 491520,
				"total": 519168,
				"leak_alarm": 1
			}
		}
	}]
}