更新时间:2023-12-27 GMT+08:00
分享

创建产品

功能介绍

应用服务器可调用此接口创建产品。此接口仅创建了产品,没有创建和安装插件,如果需要对数据进行编解码,还需要在平台开发和安装插件。

调用方法

请参见如何调用API

URI

POST /v5/iot/{project_id}/products

表1 路径参数

参数

是否必选

参数类型

描述

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参数

参数

是否必选

参数类型

描述

product_id

String

参数说明:产品ID,资源空间下唯一。用于资源空间下唯一标识一个产品。如果携带此参数,平台将产品ID设置为该参数值;如果不携带此参数,产品ID在物联网平台创建产品后由平台分配获得。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

name

String

参数说明:产品名称。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

device_type

String

参数说明:设备类型。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

protocol_type

String

参数说明:设备使用的协议类型。 取值范围:MQTT,CoAP,HTTP,HTTPS,Modbus,ONVIF,OPC-UA,OPC-DA,Other。

data_format

String

参数说明:设备上报数据的格式。 取值范围

  • json:JSON格式

  • binary:二进制码流格式 默认值json。

缺省值:json

service_capabilities

Array of ServiceCapability objects

参数说明:设备的服务能力列表。 取值范围:数组长度大小不超过500,内容大小不超过500k。

manufacturer_name

String

参数说明:厂商名称。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

industry

String

参数说明:设备所属行业。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

description

String

参数说明:产品的描述信息。 取值范围:长度不超过128,只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ,、:;。/等字符的组合。

app_id

String

参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,建议携带该参数指定创建的产品归属到哪个资源空间下,否则创建的产品将会归属到默认资源空间下。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

表4 ServiceCapability

参数

是否必选

参数类型

描述

service_id

String

参数说明:设备的服务ID。注:产品内不允许重复。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。

service_type

String

参数说明:设备的服务类型。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。

properties

Array of ServiceProperty objects

参数说明:设备服务支持的属性列表。 取值范围:数组长度大小不超过500。

commands

Array of ServiceCommand objects

参数说明:设备服务支持的命令列表。 取值范围:数组长度大小不超过500。

events

Array of ServiceEvent objects

参数说明:设备服务支持的事件列表。目前暂未支持自定义事件,创建/修改产品时无需定义该字段。 取值范围:数组长度大小不超过500。

description

String

参数说明:设备服务的描述信息。 取值范围:长度不超过128,只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ,、:;。/等字符的组合。

option

String

参数说明:指定设备服务是否必选。目前本字段为非功能性字段,仅起到标识作用。 取值范围

  • Master:主服务

  • Mandatory:必选服务

  • Optional:可选服务 默认值为Optional。

缺省值:Optional

表5 ServiceProperty

参数

是否必选

参数类型

描述

property_name

String

参数说明:设备属性名称。注:设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符:点(.)、dollar符号($)、空char(十六进制的ASCII码为00),如果包含了以上特殊字符则无法正常刷新影子文档。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

data_type

String

参数说明:设备属性的数据类型。 取值范围:int,long,decimal,string,DateTime,jsonObject,enum,boolean,string list。

required

Boolean

参数说明:设备属性是否必选。默认为false。

缺省值:false

enum_list

Array of strings

参数说明:设备属性的枚举值列表。

min

String

参数说明:设备属性的最小值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max

String

参数说明:设备属性的最大值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max_length

Integer

参数说明:设备属性的最大长度。

step

Double

参数说明:设备属性的步长。

unit

String

参数说明:设备属性的单位。 取值范围:长度不超过16。

最大长度:16

method

String

参数说明:设备属性的访问模式。 取值范围:RWE,RW,RE,WE,E,W,R。

  • R:属性值可读

  • W:属性值可写

  • E:属性值可订阅,即属性值变化时上报事件

description

String

参数说明:设备属性的描述。 取值范围:长度不超过128,只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ,、:;。/等字符的组合。

default_value

Object

参数说明:设备属性的默认值。如果设置了默认值,使用该产品创建设备时,会将该属性的默认值写入到该设备的设备影子预期数据中,待设备上线时将该属性默认值下发给设备。

表6 ServiceCommand

参数

是否必选

参数类型

描述

command_name

String

参数说明:设备命令名称。注:设备服务内不允许重复。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

paras

Array of ServiceCommandPara objects

参数说明:设备命令的参数列表。

responses

Array of ServiceCommandResponse objects

参数说明:设备命令的响应列表。

表7 ServiceCommandResponse

参数

是否必选

参数类型

描述

response_name

String

参数说明:设备命令响应名称。 取值范围:长度不超过128,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

paras

Array of ServiceCommandPara objects

参数说明:设备命令响应的参数列表。

表8 ServiceEvent

参数

是否必选

参数类型

描述

event_type

String

参数说明:设备事件类型。注:设备服务内不允许重复。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

paras

Array of ServiceCommandPara objects

参数说明:设备事件的参数列表。

表9 ServiceCommandPara

参数

是否必选

参数类型

描述

para_name

String

参数说明:参数的名称。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

data_type

String

参数说明:参数的数据类型。 取值范围:int,long,decimal,string,DateTime,jsonObject,enum,boolean,string list。

required

Boolean

参数说明:参数是否必选。默认为false。

缺省值:false

enum_list

Array of strings

参数说明:参数的枚举值列表。

min

String

参数说明:参数的最小值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max

String

参数说明:参数的最大值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max_length

Integer

参数说明:参数的最大长度。

step

Double

参数说明:参数的步长。

unit

String

参数说明:参数的单位。 取值范围:长度不超过16。

最大长度:16

description

String

参数说明:参数的描述。 取值范围:长度不超过128,只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ,、:;。/等字符的组合。

响应参数

状态码: 201

表10 响应Body参数

参数

参数类型

描述

app_id

String

资源空间ID。

app_name

String

资源空间名称。

product_id

String

产品ID,用于唯一标识一个产品,在物联网平台创建产品后由平台分配获得。

name

String

产品名称。

device_type

String

设备类型。

protocol_type

String

设备使用的协议类型。取值范围:MQTT,CoAP,HTTP,HTTPS,Modbus,ONVIF, OPC-UA,OPC-DA,Other。

data_format

String

设备上报数据的格式,取值范围:json,binary。

manufacturer_name

String

厂商名称。

industry

String

设备所属行业。

description

String

产品的描述信息。

service_capabilities

Array of ServiceCapability objects

设备的服务能力列表。

create_time

String

在物联网平台创建产品的时间,格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。

表11 ServiceCapability

参数

参数类型

描述

service_id

String

参数说明:设备的服务ID。注:产品内不允许重复。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。

service_type

String

参数说明:设备的服务类型。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。

properties

Array of ServiceProperty objects

参数说明:设备服务支持的属性列表。 取值范围:数组长度大小不超过500。

commands

Array of ServiceCommand objects

参数说明:设备服务支持的命令列表。 取值范围:数组长度大小不超过500。

events

Array of ServiceEvent objects

参数说明:设备服务支持的事件列表。目前暂未支持自定义事件,创建/修改产品时无需定义该字段。 取值范围:数组长度大小不超过500。

description

String

参数说明:设备服务的描述信息。 取值范围:长度不超过128,只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ,、:;。/等字符的组合。

option

String

参数说明:指定设备服务是否必选。目前本字段为非功能性字段,仅起到标识作用。 取值范围

  • Master:主服务

  • Mandatory:必选服务

  • Optional:可选服务 默认值为Optional。

缺省值:Optional

表12 ServiceProperty

参数

参数类型

描述

property_name

String

参数说明:设备属性名称。注:设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符:点(.)、dollar符号($)、空char(十六进制的ASCII码为00),如果包含了以上特殊字符则无法正常刷新影子文档。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

data_type

String

参数说明:设备属性的数据类型。 取值范围:int,long,decimal,string,DateTime,jsonObject,enum,boolean,string list。

required

Boolean

参数说明:设备属性是否必选。默认为false。

缺省值:false

enum_list

Array of strings

参数说明:设备属性的枚举值列表。

min

String

参数说明:设备属性的最小值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max

String

参数说明:设备属性的最大值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max_length

Integer

参数说明:设备属性的最大长度。

step

Double

参数说明:设备属性的步长。

unit

String

参数说明:设备属性的单位。 取值范围:长度不超过16。

最大长度:16

method

String

参数说明:设备属性的访问模式。 取值范围:RWE,RW,RE,WE,E,W,R。

  • R:属性值可读

  • W:属性值可写

  • E:属性值可订阅,即属性值变化时上报事件

description

String

参数说明:设备属性的描述。 取值范围:长度不超过128,只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ,、:;。/等字符的组合。

default_value

Object

参数说明:设备属性的默认值。如果设置了默认值,使用该产品创建设备时,会将该属性的默认值写入到该设备的设备影子预期数据中,待设备上线时将该属性默认值下发给设备。

表13 ServiceCommand

参数

参数类型

描述

command_name

String

参数说明:设备命令名称。注:设备服务内不允许重复。 取值范围:长度不超过64,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

paras

Array of ServiceCommandPara objects

参数说明:设备命令的参数列表。

responses

Array of ServiceCommandResponse objects

参数说明:设备命令的响应列表。

表14 ServiceCommandResponse

参数

参数类型

描述

response_name

String

参数说明:设备命令响应名称。 取值范围:长度不超过128,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

paras

Array of ServiceCommandPara objects

参数说明:设备命令响应的参数列表。

表15 ServiceEvent

参数

参数类型

描述

event_type

String

参数说明:设备事件类型。注:设备服务内不允许重复。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

paras

Array of ServiceCommandPara objects

参数说明:设备事件的参数列表。

表16 ServiceCommandPara

参数

参数类型

描述

para_name

String

参数说明:参数的名称。 取值范围:长度不超过32,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。

data_type

String

参数说明:参数的数据类型。 取值范围:int,long,decimal,string,DateTime,jsonObject,enum,boolean,string list。

required

Boolean

参数说明:参数是否必选。默认为false。

缺省值:false

enum_list

Array of strings

参数说明:参数的枚举值列表。

min

String

参数说明:参数的最小值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max

String

参数说明:参数的最大值。 取值范围:长度1-16。

最小长度:1

最大长度:16

max_length

Integer

参数说明:参数的最大长度。

step

Double

参数说明:参数的步长。

unit

String

参数说明:参数的单位。 取值范围:长度不超过16。

最大长度:16

description

String

参数说明:参数的描述。 取值范围:长度不超过128,只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ,、:;。/等字符的组合。

请求示例

创建一个产品,名称为Thermometer,服务为temperature,包含属性temperature和命令reboot。

POST https://{endpoint}/v5/iot/{project_id}/products

{
  "product_id" : "5ba24f5ebbe8f56f5a14f605",
  "name" : "Thermometer,",
  "device_type" : "Thermometer,",
  "protocol_type" : "MQTT",
  "data_format" : "json",
  "service_capabilities" : [ {
    "service_id" : "temperature,",
    "service_type" : "temperature",
    "properties" : [ {
      "property_name" : "temperature",
      "data_type" : "decimal",
      "required" : true,
      "enum_list" : null,
      "min" : "1",
      "max" : "100",
      "max_length" : 100,
      "step" : 0.1,
      "unit" : "centigrade",
      "method" : "RW",
      "description" : "force",
      "default_value" : {
        "color" : "red",
        "size" : 1
      }
    } ],
    "commands" : [ {
      "command_name" : "reboot",
      "paras" : [ {
        "para_name" : "force",
        "data_type" : "string",
        "required" : false,
        "enum_list" : null,
        "min" : "1",
        "max" : "100",
        "max_length" : 100,
        "step" : 0.1,
        "unit" : "km/h",
        "description" : "force"
      } ],
      "responses" : [ {
        "response_name" : "ACK",
        "paras" : [ {
          "para_name" : "force",
          "data_type" : "string",
          "required" : false,
          "enum_list" : null,
          "min" : "1",
          "max" : "100",
          "max_length" : 100,
          "step" : 0.1,
          "unit" : "km/h",
          "description" : "force"
        } ]
      } ]
    } ],
    "description" : "temperature",
    "option" : "Mandatory"
  } ],
  "manufacturer_name" : "ABC",
  "industry" : "smartCity",
  "description" : "this is a thermometer produced by Huawei",
  "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka"
}

响应示例

状态码: 201

Created

{
  "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
  "app_name" : "testAPP01",
  "product_id" : "5ba24f5ebbe8f56f5a14f605",
  "name" : "Thermometer",
  "device_type" : "Thermometer",
  "protocol_type" : "MQTT",
  "data_format" : "json",
  "manufacturer_name" : "ABC",
  "industry" : "smartCity",
  "description" : "this is a thermometer produced by Huawei",
  "service_capabilities" : [ {
    "service_id" : "temperature",
    "service_type" : "temperature",
    "properties" : [ {
      "property_name" : "temperature",
      "required" : true,
      "data_type" : "decimal",
      "enum_list" : null,
      "min" : "1",
      "max" : "100",
      "max_length" : 100,
      "step" : 0.1,
      "unit" : "centigrade",
      "method" : "RW",
      "description" : "force",
      "default_value" : {
        "color" : "red",
        "size" : 1
      }
    } ],
    "commands" : [ {
      "command_name" : "reboot",
      "paras" : [ {
        "para_name" : "force",
        "required" : false,
        "data_type" : "string",
        "enum_list" : null,
        "min" : "1",
        "max" : "100",
        "max_length" : 100,
        "step" : 0.1,
        "unit" : "km/h",
        "description" : "force"
      } ],
      "responses" : [ {
        "response_name" : "ACK",
        "paras" : [ {
          "para_name" : "force",
          "required" : false,
          "data_type" : "string",
          "enum_list" : null,
          "min" : "1",
          "max" : "100",
          "max_length" : 100,
          "step" : 0.1,
          "unit" : "km/h",
          "description" : "force"
        } ]
      } ]
    } ],
    "description" : "temperature",
    "option" : "Mandatory"
  } ],
  "create_time" : "20190303T081011Z"
}

SDK代码示例

SDK代码示例如下。

创建一个产品,名称为Thermometer,服务为temperature,包含属性temperature和命令reboot。

  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
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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.iotda.v5.region.IoTDARegion;
import com.huaweicloud.sdk.iotda.v5.*;
import com.huaweicloud.sdk.iotda.v5.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateProductSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withDerivedPredicate(AbstractCredentials.DEFAULT_DERIVED_PREDICATE) // Used in derivative ak/sk authentication scenarios
                .withAk(ak)
                .withSk(sk);

        IoTDAClient client = IoTDAClient.newBuilder()
                .withCredential(auth)
                .withRegion(IoTDARegion.valueOf("<YOUR REGION>"))
                .build();
        CreateProductRequest request = new CreateProductRequest();
        AddProduct body = new AddProduct();
        List<ServiceCommandPara> listResponsesParas = new ArrayList<>();
        listResponsesParas.add(
            new ServiceCommandPara()
                .withParaName("force")
                .withDataType("string")
                .withRequired(false)
                .withMin("1")
                .withMax("100")
                .withMaxLength(100)
                .withStep((double)0.1)
                .withUnit("km/h")
                .withDescription("force")
        );
        List<ServiceCommandResponse> listCommandsResponses = new ArrayList<>();
        listCommandsResponses.add(
            new ServiceCommandResponse()
                .withResponseName("ACK")
                .withParas(listResponsesParas)
        );
        List<ServiceCommandPara> listCommandsParas = new ArrayList<>();
        listCommandsParas.add(
            new ServiceCommandPara()
                .withParaName("force")
                .withDataType("string")
                .withRequired(false)
                .withMin("1")
                .withMax("100")
                .withMaxLength(100)
                .withStep((double)0.1)
                .withUnit("km/h")
                .withDescription("force")
        );
        List<ServiceCommand> listServiceCapabilitiesCommands = new ArrayList<>();
        listServiceCapabilitiesCommands.add(
            new ServiceCommand()
                .withCommandName("reboot")
                .withParas(listCommandsParas)
                .withResponses(listCommandsResponses)
        );
        List<ServiceProperty> listServiceCapabilitiesProperties = new ArrayList<>();
        listServiceCapabilitiesProperties.add(
            new ServiceProperty()
                .withPropertyName("temperature")
                .withDataType("decimal")
                .withRequired(true)
                .withMin("1")
                .withMax("100")
                .withMaxLength(100)
                .withStep((double)0.1)
                .withUnit("centigrade")
                .withMethod("RW")
                .withDescription("force")
                .withDefaultValue("{\"color\":\"red\",\"size\":1}")
        );
        List<ServiceCapability> listbodyServiceCapabilities = new ArrayList<>();
        listbodyServiceCapabilities.add(
            new ServiceCapability()
                .withServiceId("temperature,")
                .withServiceType("temperature")
                .withProperties(listServiceCapabilitiesProperties)
                .withCommands(listServiceCapabilitiesCommands)
                .withDescription("temperature")
                .withOption("Mandatory")
        );
        body.withAppId("jeQDJQZltU8iKgFFoW060F5SGZka");
        body.withDescription("this is a thermometer produced by Huawei");
        body.withIndustry("smartCity");
        body.withManufacturerName("ABC");
        body.withServiceCapabilities(listbodyServiceCapabilities);
        body.withDataFormat("json");
        body.withProtocolType("MQTT");
        body.withDeviceType("Thermometer,");
        body.withName("Thermometer,");
        body.withProductId("5ba24f5ebbe8f56f5a14f605");
        request.withBody(body);
        try {
            CreateProductResponse response = client.createProduct(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());
        }
    }
}

创建一个产品,名称为Thermometer,服务为temperature,包含属性temperature和命令reboot。

  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
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcore.auth.credentials import DerivedCredentials
from huaweicloudsdkiotda.v5.region.iotda_region import IoTDARegion
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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

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

    client = IoTDAClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(IoTDARegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateProductRequest()
        listParasResponses = [
            ServiceCommandPara(
                para_name="force",
                data_type="string",
                required=False,
                min="1",
                max="100",
                max_length=100,
                step=0.1,
                unit="km/h",
                description="force"
            )
        ]
        listResponsesCommands = [
            ServiceCommandResponse(
                response_name="ACK",
                paras=listParasResponses
            )
        ]
        listParasCommands = [
            ServiceCommandPara(
                para_name="force",
                data_type="string",
                required=False,
                min="1",
                max="100",
                max_length=100,
                step=0.1,
                unit="km/h",
                description="force"
            )
        ]
        listCommandsServiceCapabilities = [
            ServiceCommand(
                command_name="reboot",
                paras=listParasCommands,
                responses=listResponsesCommands
            )
        ]
        listPropertiesServiceCapabilities = [
            ServiceProperty(
                property_name="temperature",
                data_type="decimal",
                required=True,
                min="1",
                max="100",
                max_length=100,
                step=0.1,
                unit="centigrade",
                method="RW",
                description="force",
                default_value="{\"color\":\"red\",\"size\":1}"
            )
        ]
        listServiceCapabilitiesbody = [
            ServiceCapability(
                service_id="temperature,",
                service_type="temperature",
                properties=listPropertiesServiceCapabilities,
                commands=listCommandsServiceCapabilities,
                description="temperature",
                option="Mandatory"
            )
        ]
        request.body = AddProduct(
            app_id="jeQDJQZltU8iKgFFoW060F5SGZka",
            description="this is a thermometer produced by Huawei",
            industry="smartCity",
            manufacturer_name="ABC",
            service_capabilities=listServiceCapabilitiesbody,
            data_format="json",
            protocol_type="MQTT",
            device_type="Thermometer,",
            name="Thermometer,",
            product_id="5ba24f5ebbe8f56f5a14f605"
        )
        response = client.create_product(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建一个产品,名称为Thermometer,服务为temperature,包含属性temperature和命令reboot。

  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
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
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/services/iotda/v5/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithDerivedPredicate(core_auth.GetDefaultDerivedPredicate()). // Used in derivative ak/sk authentication scenarios
        Build()

    client := iotda.NewIoTDAClient(
        iotda.IoTDAClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateProductRequest{}
	requiredParas:= false
	minParas:= "1"
	maxParas:= "100"
	maxLengthParas:= int32(100)
	stepParas:= float64(0.1)
	unitParas:= "km/h"
	descriptionParas:= "force"
	var listParasResponses = []model.ServiceCommandPara{
        {
            ParaName: "force",
            DataType: "string",
            Required: &requiredParas,
            Min: &minParas,
            Max: &maxParas,
            MaxLength: &maxLengthParas,
            Step: &stepParas,
            Unit: &unitParas,
            Description: &descriptionParas,
        },
    }
	var listResponsesCommands = []model.ServiceCommandResponse{
        {
            ResponseName: "ACK",
            Paras: &listParasResponses,
        },
    }
	requiredParas1:= false
	minParas1:= "1"
	maxParas1:= "100"
	maxLengthParas1:= int32(100)
	stepParas1:= float64(0.1)
	unitParas1:= "km/h"
	descriptionParas1:= "force"
	var listParasCommands = []model.ServiceCommandPara{
        {
            ParaName: "force",
            DataType: "string",
            Required: &requiredParas1,
            Min: &minParas1,
            Max: &maxParas1,
            MaxLength: &maxLengthParas1,
            Step: &stepParas1,
            Unit: &unitParas1,
            Description: &descriptionParas1,
        },
    }
	var listCommandsServiceCapabilities = []model.ServiceCommand{
        {
            CommandName: "reboot",
            Paras: &listParasCommands,
            Responses: &listResponsesCommands,
        },
    }
	requiredProperties:= true
	minProperties:= "1"
	maxProperties:= "100"
	maxLengthProperties:= int32(100)
	stepProperties:= float64(0.1)
	unitProperties:= "centigrade"
	descriptionProperties:= "force"
	defaultValueProperties:= "{\"color\":\"red\",\"size\":1}"
	var defaultValuePropertiesInterface interface{} = defaultValueProperties
	var listPropertiesServiceCapabilities = []model.ServiceProperty{
        {
            PropertyName: "temperature",
            DataType: "decimal",
            Required: &requiredProperties,
            Min: &minProperties,
            Max: &maxProperties,
            MaxLength: &maxLengthProperties,
            Step: &stepProperties,
            Unit: &unitProperties,
            Method: "RW",
            Description: &descriptionProperties,
            DefaultValue: &defaultValuePropertiesInterface,
        },
    }
	descriptionServiceCapabilities:= "temperature"
	optionServiceCapabilities:= "Mandatory"
	var listServiceCapabilitiesbody = []model.ServiceCapability{
        {
            ServiceId: "temperature,",
            ServiceType: "temperature",
            Properties: &listPropertiesServiceCapabilities,
            Commands: &listCommandsServiceCapabilities,
            Description: &descriptionServiceCapabilities,
            Option: &optionServiceCapabilities,
        },
    }
	appIdAddProduct:= "jeQDJQZltU8iKgFFoW060F5SGZka"
	descriptionAddProduct:= "this is a thermometer produced by Huawei"
	industryAddProduct:= "smartCity"
	manufacturerNameAddProduct:= "ABC"
	productIdAddProduct:= "5ba24f5ebbe8f56f5a14f605"
	request.Body = &model.AddProduct{
		AppId: &appIdAddProduct,
		Description: &descriptionAddProduct,
		Industry: &industryAddProduct,
		ManufacturerName: &manufacturerNameAddProduct,
		ServiceCapabilities: listServiceCapabilitiesbody,
		DataFormat: "json",
		ProtocolType: "MQTT",
		DeviceType: "Thermometer,",
		Name: "Thermometer,",
		ProductId: &productIdAddProduct,
	}
	response, err := client.CreateProduct(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

201

Created

400

Bad Request

403

FORBIDDEN

错误码

请参见错误码

分享:

    相关文档

    相关产品