Query Electricity Safety Rule

Last Updated on : 2023-06-15 05:58:59

Query a specified electricity safety rule of an electrical device.

API address

GET: /v1.0/iot-03/power-devices/{device_id}/safety-rules

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.
rule_types	String	query	true	The type of safety rules. Multiple rules are separated with commas (,).

Return parameter

Parameter name	Type	Description
result	List	The information about a specified electricity safety rule of an electrical device.

Description of result

Parameter name	Type	Description
rule_type	String	The type of safety rules.
rule_threshold	Integer	The threshold of safety rules.
support	Boolean	`true`: The device supports this rule. `false`: The device does not support this rule.
switch_off	Boolean	`true`: Power off when the threshold is reached. `false`: Do not power off when the threshold is reached.

Request example

GET: /v1.0/iot-03/power-devices/6c814919a3f54fb4eb****/safety-rules?rule_types=ov_cr,ov_vol,overload,undervoltage

Return example

{
    "result": [
        {
            "rule_type": "overload",
            "switch_off": true,
            "rule_threshold": 13,
            "support": true
        },
        {
            "rule_type": "ov_vol",
            "switch_off": true,
            "rule_threshold": 275,
            "support": true
        },
        {
            "rule_type": "ov_cr",
            "switch_off": true,
            "rule_threshold": 63,
            "support": true
        },
        {
            "rule_type": "undervoltage",
            "switch_off": true,
            "rule_threshold": 160,
            "support": true
        }
    ],
    "t": 1637833388218,
    "success": true
}

Error code

For more information, see error code.

Prev DocPower Safety

Next DocSet Up Electricity Safety Rule