Updated on 2023-02-16 GMT+08:00

Platform Delivering a Log Collection Notification

Topic

Downstream: $oc/devices/{device_id}/sys/events/down

Function

This API is used by the platform to deliver a log collection notification to devices.

Parameters

Parameter

Mandatory or Optional

Type

Description

services

Optional

List<EventService>

Indicates a list of services that the event is about.

EventService structure

Parameter

Mandatory or Optional

Type

Description

service_id

Mandatory

String

System field. The value is fixed to $log.

event_type

Mandatory

String

System field. The value is fixed to log_config.

event_time

Optional

String

Indicates the time when the event occurs.

paras

Mandatory

Object

Indicates the list of service events, which are defined in the product model associated with the device.

paras structure

Parameter

Mandatory or Optional

Type

Description

switch

Optional

String

Indicates the device log collection switch.

on: enables device log collection.

off: disables device log collection.

end_time

Optional

String

Indicates the time when log collection ends.

yyyyMMdd'T'HHmmss'Z'

Example

Topic: $oc/devices/{device_id}/sys/events/down   
Data format:
{    
    "services": [{  
        "service_id": "$log",  
        "event_type": "log_config", 
        "event_time": "20151212T121212Z",
        "paras": {  
             "switch": "on",
             "end_time": "20151212T131212Z"
        }  
    }]  
}