设备接入
| 产品详情
  • 产品管理
    • 创建产品CreateProduct
    • 删除产品DeleteProduct
    • 查询产品列表ListProducts
    • 查询产品ShowProduct
    • 修改产品UpdateProduct
  • 设备管理
    • 创建设备AddDevice
    • 修改设备网关ChangeGateway
    • 删除设备DeleteDevice
    • 冻结设备FreezeDevice
    • 查询指定设备加入的设备组列表ListDeviceGroupsByDevice
    • 查询设备列表ListDevices
    • 重置设备密钥ResetDeviceSecret
    • 重置设备指纹ResetFingerprint
    • 灵活搜索设备列表SearchDevices
    • 查询设备ShowDevice
    • 解冻设备UnfreezeDevice
    • 修改设备UpdateDevice
  • 设备消息
    • 下发设备消息CreateMessage
    • 查询设备消息ListDeviceMessages
    • 查询指定消息id的消息ShowDeviceMessage
  • 设备命令
    • 下发设备命令CreateCommand
  • 设备异步命令
    • 统计设备下的历史命令总数CountAsyncHistoryCommands
    • 下发异步设备命令CreateAsyncCommand
    • 查询设备下队列中的命令ListAsyncCommands
    • 查询设备下的历史命令ListAsyncHistoryCommands
    • 查询指定id的命令ShowAsyncDeviceCommand
  • 设备属性
    • 查询设备属性ListProperties
    • 修改设备属性UpdateProperties
  • AMQP队列管理
    • 创建AMQP队列AddQueue
    • 查询AMQP列表BatchShowQueue
    • 删除AMQP队列DeleteQueue
    • 查询单个AMQP队列ShowQueue
  • 接入凭证管理
    • 生成接入凭证CreateAccessCode
  • 数据流转规则管理
    • 创建规则触发条件CreateRoutingRule
    • 创建规则动作CreateRuleAction
    • 删除规则触发条件DeleteRoutingRule
    • 删除规则动作DeleteRuleAction
    • 查询规则条件列表ListRoutingRules
    • 查询规则动作列表ListRuleActions
    • 查询规则条件ShowRoutingRule
    • 查询规则动作ShowRuleAction
    • 修改规则触发条件UpdateRoutingRule
    • 修改规则动作UpdateRuleAction
  • 数据转发积压策略管理
    • 新建数据流转积压策略CreateRoutingBacklogPolicy
    • 删除数据流转积压策略DeleteRoutingBacklogPolicy
    • 查询数据流转积压策略列表ListRoutingBacklogPolicy
    • 查询数据流转积压策略ShowRoutingBacklogPolicy
    • 修改数据流转积压策略UpdateRoutingBacklogPolicy
  • 数据转发流控策略管理
    • 新建数据流转流控策略CreateRoutingFlowControlPolicy
    • 删除数据流转流控策略DeleteRoutingFlowControlPolicy
    • 查询数据流转流控策略列表ListRoutingFlowControlPolicy
    • 查询数据流转流控策略ShowRoutingFlowControlPolicy
    • 修改数据流转流控策略UpdateRoutingFlowControlPolicy
  • 设备联动规则
    • 修改规则状态ChangeRuleStatus
    • 创建规则CreateRule
    • 删除规则DeleteRule
    • 查询规则列表ListRules
    • 查询规则ShowRule
    • 修改规则UpdateRule
  • 设备影子
    • 查询设备影子数据ShowDeviceShadow
    • 配置设备影子预期数据UpdateDeviceShadowDesiredData
  • 设备组管理
    • 添加设备组AddDeviceGroup
    • 管理设备组中的设备CreateOrDeleteDeviceInGroup
    • 删除设备组DeleteDeviceGroup
    • 查询设备组列表ListDeviceGroups
    • 查询设备组ShowDeviceGroup
    • 查询设备组设备列表ShowDevicesInGroup
    • 修改设备组UpdateDeviceGroup
  • 标签管理
    • 按标签查询资源ListResourcesByTags
    • 绑定标签TagDevice
    • 解绑标签UntagDevice
  • 资源空间管理
    • 创建资源空间AddApplication
    • 删除资源空间DeleteApplication
    • 查询资源空间ShowApplication
    • 查询资源空间列表ShowApplications
    • 更新资源空间UpdateApplication
  • 批量任务
    • 创建批量任务CreateBatchTask
    • 删除批量任务DeleteBatchTask
    • 查询批量任务列表ListBatchTasks
    • 重试批量任务RetryBatchTask
    • 查询批量任务ShowBatchTask
    • 停止批量任务StopBatchTask
  • 批量任务的文件管理
    • 删除批量任务文件DeleteBatchTaskFile
    • 查询批量任务文件列表ListBatchTaskFiles
    • 上传批量任务文件UploadBatchTaskFile
  • 设备CA证书管理
    • 上传设备CA证书AddCertificate
    • 验证设备CA证书CheckCertificate
    • 删除设备CA证书DeleteCertificate
    • 获取设备CA证书列表ListCertificates
    • 更新CA证书UpdateCertificate
  • OTA升级包管理
    • 创建OTA升级包CreateOtaPackage
    • 删除OTA升级包DeleteOtaPackage
    • 查询OTA升级包列表ListOtaPackageInfo
    • 获取OTA升级包详情ShowOtaPackage
  • 设备隧道管理
    • 创建设备隧道AddTunnel
    • 关闭设备隧道CloseDeviceTunnel
    • 删除设备隧道DeleteDeviceTunnel
    • 查询设备所有隧道ListDeviceTunnels
    • 查询设备隧道ShowDeviceTunnel
  • 设备代理
    • 创建设备代理CreateDeviceProxy
    • 删除设备代理DeleteDeviceProxy
    • 查询设备代理列表ListDeviceProxies
    • 查询设备代理详情ShowDeviceProxy
    • 修改设备代理UpdateDeviceProxy
  • 广播消息
    • 下发广播消息BroadcastMessage
  • 网桥管理
    • 创建网桥AddBridge
    • 删除网桥DeleteBridge
    • 查询网桥列表ListBridges
    • 重置网桥密钥ResetBridgeSecret
  • 编解码函数管理
    • 创建编解码函数AddFunctions
    • 删除编解码函数DeleteFunctions
    • 查询编解码函数ListFunctions
  • 预调配模板管理
    • 创建预调配模板CreateProvisioningTemplate
    • 删除预调配模板DeleteProvisioningTemplate
    • 查询预调配模板列表ListProvisioningTemplates
    • 查询预调配模板详情ShowProvisioningTemplate
    • 更新指定id的预调配模板信息UpdateProvisioningTemplate
  • 自定义鉴权
    • 创建自定义鉴权CreateDeviceAuthorizer
    • 删除自定义鉴权DeleteDeviceAuthorizer
    • 查询自定义鉴权列表ListDeviceAuthorizers
    • 查询自定义鉴权详情ShowDeviceAuthorizer
    • 更新指定id的自定义鉴权UpdateDeviceAuthorizer
  • 设备策略管理
    • 绑定设备策略BindDevicePolicy
    • 创建设备策略CreateDevicePolicy
    • 删除设备策略DeleteDevicePolicy
    • 查询设备策略列表ListDevicePolicies
    • 查询设备策略详情ShowDevicePolicy
    • 查询设备策略绑定的目标列表ShowTargetsInDevicePolicy
    • 解绑设备策略UnbindDevicePolicy
    • 更新设备策略信息UpdateDevicePolicy

UpdateProperties

修改设备属性

PUT
https://iotda.af-south-1.myhuaweicloud.com/v5/iot/{project_id}/devices/{device_id}/properties
高级设置
只看必填项
填写默认值
密文显示特定参数
*
Region
*
instance_id
Headers
*
Authorization
*
Instance-Id
Parameters
*
device_id
*
project_id
Body
*{
*
services
:
}

功能介绍

设备的产品模型中定义了物联网平台可向设备下发的属性,应用服务器可调用此接口向指定设备下发属性。平台负责将属性以同步方式发送给设备,并将设备执行属性结果同步返回。

注意:此接口适用于MQTT设备,暂不支持NB-IoT设备。

调用方法

请参见如何调用API

URI

PUT /v5/iot/{project_id}/devices/{device_id}/properties

表1 路径参数

参数

是否必选

参数类型

描述

device_id

String

参数说明:下发属性的设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。

取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。

project_id

String

参数说明:项目ID。获取方法请参见 获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情

表3 请求Body参数

参数

是否必选

参数类型

描述

services

Object

参数说明:设备执行的属性,Json格式,里面是一个个键值对,如果serviceId不为空,每个键都是profile中属性的参数名(paraName);如果serviceId为空则由用户自定义属性格式。设属性示例:[{"service_id": "Temperature","properties": {"value": 57}},{"service_id": "Battery","properties": {"level": 80}}],具体格式需要应用和设备约定, 最大长度为256KB。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

设备属性更新ID,用于唯一标识一条属性更新,在下发更新属性时由物联网平台分配获得。

response

Object

设备上报的属性执行结果。Json格式,具体格式需要应用和设备约定。

error_code

String

属性更新异常错误码。

error_msg

String

属性更新异常错误信息。

请求示例

下发设备属性,服务id为Temperature的属性为value,值为57,服务id为Batter的属性为level,值为80。

PUT https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/properties

{
  "services" : [ {
    "service_id" : "Temperature",
    "properties" : {
      "value" : 57
    }
  }, {
    "service_id" : "Battery",
    "properties" : {
      "level" : 80
    }
  } ]
}

响应示例

状态码: 200

OK

{
  "request_id" : "b1224afb-e9f0-4916-8220-b6bab568e888",
  "response" : {
    "result_code" : 0,
    "result_desc" : "success"
  },
  "error_code" : "string",
  "error_msg" : "string"
}

SDK代码示例

SDK代码示例如下。

下发设备属性,服务id为Temperature的属性为value,值为57,服务id为Batter的属性为level,值为80。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.AbstractCredentials;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.core.region.Region;
import com.huaweicloud.sdk.iotda.v5.*;
import com.huaweicloud.sdk.iotda.v5.model.*;


public class UpdatePropertiesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        // ENDPOINT:请在控制台的"总览"界面的"平台接入地址"中查看“应用侧”的https接入地址。
        String iotdaEndpoint = "<YOUR ENDPOINT>";
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                // 标准版/企业版需要使用衍生算法,基础版请删除配置"withDerivedPredicate";
                .withDerivedPredicate(AbstractCredentials.DEFAULT_DERIVED_PREDICATE) // Used in derivative ak/sk authentication scenarios
                .withAk(ak)
                .withSk(sk);

        IoTDAClient client = IoTDAClient.newBuilder()
                .withCredential(auth)
                // 标准版/企业版:需自行创建Region对象,基础版:请使用IoTDARegion的region对象,如"withRegion(IoTDARegion.CN_NORTH_4)"
                .withRegion(new Region("cn-north-4", iotdaEndpoint))
                .build();
        UpdatePropertiesRequest request = new UpdatePropertiesRequest();
        request.withDeviceId("{device_id}");
        DevicePropertiesRequest body = new DevicePropertiesRequest();
        body.withServices("[{\"service_id\":\"Temperature\",\"properties\":{\"value\":57}}, {\"service_id\":\"Battery\",\"properties\":{\"level\":80}}]");
        request.withBody(body);
        try {
            UpdatePropertiesResponse response = client.updateProperties(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

下发设备属性,服务id为Temperature的属性为value,值为57,服务id为Batter的属性为level,值为80。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcore.auth.credentials import DerivedCredentials
from huaweicloudsdkcore.region.region import Region as coreRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkiotda.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    // ENDPOINT请在控制台的"总览"界面的"平台接入地址"中查看应用侧的https接入地址
    iotdaEndpoint = "<YOUR ENDPOINT>";
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId).with_derived_predicate(DerivedCredentials.get_default_derived_predicate())

    client = IoTDAClient.new_builder() \
        .with_credentials(credentials) \
        # 标准版/企业版:需要使用自行创建的Region对象,基础版:请选择IoTDAClient中的Region对象 如: .with_region(IoTDARegion.CN_NORTH_4)
        .with_region(coreRegion(id="cn-north-4", endpoint=endpoint)) \
        .build()

    try:
        request = UpdatePropertiesRequest()
        request.device_id = "{device_id}"
        request.body = DevicePropertiesRequest(
            services="[{\"service_id\":\"Temperature\",\"properties\":{\"value\":57}}, {\"service_id\":\"Battery\",\"properties\":{\"level\":80}}]"
        )
        response = client.update_properties(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

下发设备属性,服务id为Temperature的属性为value,值为57,服务id为Batter的属性为level,值为80。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    iotda "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/region"
    core_auth "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    // endpoint:请在控制台的"总览"界面的"平台接入地址"中查看"应用侧"的https接入地址
    endpoint := "<YOUR ENDPOINT>"
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        // 企业版/标准版需要使用衍生算法,基础版请删除该配置"WithDerivedPredicate"
        WithDerivedPredicate(core_auth.GetDefaultDerivedPredicate()). // Used in derivative ak/sk authentication scenarios
        Build()

    client := iotda.NewIoTDAClient(
        iotda.IoTDAClientBuilder().
            // 标准版/企业版需要自行创建region,基础版使用IoTDARegion中的region对象
            WithRegion(region.NewRegion("cn-north-4", endpoint)).
            WithCredential(auth).
            Build())

    request := &model.UpdatePropertiesRequest{}
	request.DeviceId = "{device_id}"
	var servicesDevicePropertiesRequest interface{} = "[{\"service_id\":\"Temperature\",\"properties\":{\"value\":57}}, {\"service_id\":\"Battery\",\"properties\":{\"level\":80}}]"
	request.Body = &model.DevicePropertiesRequest{
		Services: &servicesDevicePropertiesRequest,
	}
	response, err := client.UpdateProperties(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
SDK代码示例
状态码
错误码