获取设备影子

GET

/index.php

用于获取设备影子。

需要认证：在查询参数 key 或请求体 api_key 中传入用户 API Key；要求会话的接口还需传入 session_token。

请求可使用 JSON（Content-Type: application/json）或表单编码；字段含义、必填性和示例以本接口定义为准。

可能的失败结果

HTTP 状态	errno	英文错误信息	中文释义
400	`400001`	A required parameter is missing.	缺少必填参数。
403	`403004`	The device does not belong to the current user.	该设备不属于当前用户。

所有响应均包含 request_id，排查问题时请一并提供该值。

请求参数

Authorization

API Key

在 query 添加参数

key

示例：

key: ********************

Query 参数

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://qiuxian.net.cn//index.php?route=api%2Fshadow%2Fshadow&key=&key=%3Capi-key%3E&product_id=&device_secret='

返回响应

🟢200

application/json

成功

Bodyapplication/json

示例

{
    "errno": 0,
    "data": {
        "reported": {
            "temperature": 25.6,
            "humidity": 65.2,
            "led_state": "on"
        },
        "desired": {
            "led_state": "off"
        },
        "version": 42,
        "updated_at": "2024-01-15 10:30:00"
    }
}

🟠400

🟠403

修改于 2026-10-20 12:34:11

获取设备影子

可能的失败结果#

请求参数

请求示例代码

返回响应

可能的失败结果