更新组织设备影子配置

POST

/openapi/v0.9/manage/api/v1/organizations/{org_uuid}/manage-devices/shadows

es-management-service

更新组织内指定设备的影子配置,支持高度限制、距离限制、避障功能等参数设置

请求参数

Path 参数

org_uuid

string

必需

Header 参数

x-user-token

string

必需

默认值:

X-Request-Id

string

可选

默认值:

{% mock 'uuid' %}

Body 参数application/json

device_sn

string

可选

设备序列号
required: true
example: ABCD1234567890

state

array [object {1}]

可选

设备影子期望状态列表
每个元素代表一个需要更新的配置项组
required: true
minItems: 1

desired

object

可选

期望状态配置,key为配置项,value为配置值
支持的配置项:
height_limit: 高度限制,单位:米
obstacle_avoidance: 避障功能状态,true/false
air_transfer_enable: 照片空中回传,true/false
night_lights_state: 飞行器夜航灯 0关 1开
distance_limit_status: 限远

// 关闭夜航灯
{
    "state": [
        {
            "desired": {
                "air_transfer_enable": false
            }
        }
    ],
    "device_sn": "xxxx"
}
//开启夜航灯
{
    "state": [
        {
            "desired": {
                "night_lights_state": 1
            }
        }
    ],
    "device_sn": "xxxx"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/openapi/v0.9/manage/api/v1/organizations//manage-devices/shadows' \
--header 'x-user-token;' \
--header 'X-Request-Id: {% mock '\''uuid'\'' %}' \
--header 'Content-Type: application/json' \
--data-raw '// 关闭夜航灯
{
    "state": [
        {
            "desired": {
                "air_transfer_enable": false
            }
        }
    ],
    "device_sn": "xxxx"
}
//开启夜航灯
{
    "state": [
        {
            "desired": {
                "night_lights_state": 1
            }
        }
    ],
    "device_sn": "xxxx"
}'

返回响应

🟢200成功

application/json

成功响应,包含更新结果

Body

HTTP响应模板

code

integer

响应码

可选

message

string

响应消息

可选

data

object | null

响应数据

可选

result_code

integer

可选

执行结果代码
example: 0
enum: 0,1,2
0-成功, 1-失败, 2-执行中

string

可选

设备序列号
example: 1581F8HHD24B10010084

state

object

设备影子状态

可选

示例

{
    "code": 0,
    "message": "OK",
    "data": null
}

修改于 2025-06-27 12:01:55

更新飞机解禁证书列表