Help Center/ IoT Device Access/ API Reference/ MQTT or MQTTS API Reference on the Device Side/ Device Log Collection/ Platform Delivering a Log Collection Notification
Updated on 2024-12-02 GMT+08:00
View PDF
Share

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/Optional

Type

Description

services

Optional

List<EventService>

Explanation:

List of services that an event is about.

EventService structure

Parameter

Mandatory/Optional

Type

Description

service_id

Mandatory

String

Explanation:

System field.

Value range:

Fixed at $log.

event_type

Mandatory

String

Explanation:

System field.

Value range:

Fixed at log_config.

event_time

Optional

String

Explanation:

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

paras

Mandatory

Object

Explanation:

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

paras structure

Parameter

Mandatory/Optional

Type

Description

switch

Optional

String

Explanation:

Device log collection switch.

Value range:

on: enables device log collection.

off: disables device log collection.

end_time

Optional

String

Explanation:

End time of log collection. The time format is 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"
        }  
    }]  
}
Parent topic: Device Log Collection