获取群组支持的状态集

更新时间：2023-06-15 05:03:50

本文介绍获取群组支持的状态集的 API。

接口描述

通过群组 ID 获取群组支持的状态集。

接口地址

GET: /v1.0/iot-03/device-groups/{group_id}/status-set

请求参数

参数名	类型	参数位置	是否必填	说明
group_id	String	uri	true	群组 ID

返回参数

参数名	类型	说明
result	GroupStatusRes	群组状态集结果

result 说明

参数名	类型	说明
group_id	String	设备群组 ID
status	List	设备群组状态集

status 说明

参数名	类型	说明
name	String	状态名称
desc	String	状态描述
code	String	状态码
type	String	状态类型
values	String	状态值

请求示例

GET: /v1.0/iot-03/device-groups/12kljskerexxxxd23w/status-set

返回示例

{
    "result": {
        "group_id": "1425638346989768773",
        "status": [
            {
                "code": "report_period_set",
                "values": "{\"range\":[\"1h\",\"2h\",\"3h\",\"4h\",\"6h\",\"8h\",\"12h\",\"24h\",\"48h\",\"72h\"]}",
                "type": "Enum",
                "name": "report period set"
            },
            {
                "code": "prepayment_switch",
                "values": "{}",
                "type": "Boolean",
                "name": "prepayment switch"
            },
            {
                "code": "auto_clean",
                "values": "{}",
                "type": "Boolean",
                "name": "auto clean"
            },
            {
                "code": "charge_money",
                "values": "{\"unit\":\"¥\",\"min\":0,\"max\":999999,\"scale\":2,\"step\":1}",
                "type": "Integer",
                "name": "charge money"
            },
            {
                "code": "balance",
                "values": "{\"unit\":\"¥\",\"min\":0,\"max\":999999,\"scale\":2,\"step\":1}",
                "type": "Integer",
                "name": "balance"
            },
            {
                "code": "temp_current",
                "values": "{\"unit\":\"℃\",\"min\":-100,\"max\":100,\"scale\":0,\"step\":1}",
                "type": "Integer",
                "name": "temp current"
            },
            {
                "code": "gas_use_data",
                "values": "{\"unit\":\"m3\",\"min\":0,\"max\":99999999,\"scale\":3,\"step\":1}",
                "type": "Integer",
                "name": "gas use data"
            },
            {
                "code": "cold_switch",
                "values": "{}",
                "type": "Boolean",
                "name": "cold switch"
            }
        ]
    },
    "t": 1629354647528,
    "success": true
}

错误码

参考错误码。