Help Center/ IoT Device Access/ API Reference/ MQTT or MQTTS API Reference on the Device Side/ Remote Configuration/ Device Reporting the Configuration Response
Updated on 2024-12-02 GMT+08:00
View PDF
Share

Device Reporting the Configuration Response

Function

This API is used by a device to report the configuration result. When creating a remote configuration task, you can configure a timeout interval (1 to 30 days). If not configured, the timeout interval is set to 30 days by default. The platform delivers configuration items to the device every 24 hours within the timeout interval until the device returns a configuration response. If the device does not return a configuration response within the timeout interval, the platform will display a message indicating that the configuration task times out.

Topic

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

Parameters

Parameter

Mandatory/Optional

Type

Description

object_device_id

Optional

String

Explanation:

  • Mandatory when the child device reports data during the gateway device data reporting. Specify object_device_id as the child device ID of the device in the topic. Otherwise, the request fails.
  • When a directly connected device reports data, the value of object_device_id must be the same as that of device_id in the topic.
  • If this parameter is left blank, the value of this parameter is the same as that of device_id in the topic by default.

services

Optional

List<ServiceEvent>

Explanation:

List of services that an event is about.

ServiceEvent structure

Parameter

Mandatory/Optional

Type

Description

service_id

Mandatory

String

Explanation:

System field.

Value range:

Fixed at $device_config.

event_type

Mandatory

String

Explanation:

System field.

Value range:

Fixed at config_update_response.

event_time

Optional

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

Mandatory

Object

Explanation:

Event parameters in JSON format.

paras structure

Parameter

Mandatory/Optional

Type

Description

result_code

Mandatory

Integer

Explanation:

Device configuration result.

Value range:

Result codes definition:

  • 0: successful
  • Other integers: abnormal

description

Optional

String

Explanation:

Describes the configuration result, such as the cause for configuration failure.

Example

Topic: $oc/devices/{device_id}/sys/events/up  
Data format:
{
    "object_device_id":"{object_device_id}",
    "services":[
        {
            "service_id":"$device_config",
            "event_type":"config_update_response",
            "event_time":"20151212T121212Z",
            "paras":{
                "result_code":0,
                "description":"update config success"
            }
        }
    ]
}
Parent topic: Remote Configuration