设备接入 IOTDA-创建预调配模板:请求参数
下载设备接入 IOTDA用户手册完整版
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
template_name |
是 |
String |
参数说明：预调配模板名称。 取值范围：长度不超过128，只允许中文、字母、数字、下划线（_）、连接符（-）的组合。 |
description |
否 |
String |
参数说明：预调配模板的描述信息。 取值范围：长度不超过2048，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合 最大长度：2048 |
template_body |
是 |
ProvisioningTemplateBody object |
参数说明：预调配模板详细内容，json格式。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
parameters |
是 |
Object |
参数说明：预调配模板参数， ，配置格式为{"parameter":{"type":"String"}} ，其中parameter目前支持从预调配设备的证书的使用者字段提取内容，证书必须包含模板中定义的所有参数值，华为云IoT平台定义了可在预调配模板中声明和引用的如下参数:
type描述parameter的类型，目前仅支持string。 配置样例： '{"iotda::certificate::country":{"type":"String"}, "iotda::certificate::organization":{"type":"String"}, "iotda::certificate::organizational_unit":{"type":"String"}, "iotda::certificate::distinguished_name_qualifier":{"type":"String"}, "iotda::certificate::state_name":{"type":"String"}, "iotda::certificate::common_name":{"type":"String"}, "iotda::certificate::serial_number":{"type":"String"}}' |
resources |
是 |
TemplateResource object |
预调配模板设备资源结构体。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
device |
是 |
DeviceResource object |
预调配模板设备资源详情结构体。 |
policy |
否 |
PolicyResource object |
预调配模板设备策略资源详情结构体。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
device_name |
否 |
ParameterRef object |
设备名称 |
node_id |
是 |
ParameterRef object |
设备标识码 |
product_id |
是 |
Object |
参数说明：设备所属的产品id，可以是一个明确的静态字符串id，也可以是动态的模板参数引用
|
tags |
否 |
Array of TagRef objects |
参数说明：设备绑定的标签列表 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
tag_key |
否 |
Object |
参数说明：标签键名称，可以是一个明确的静态字符串，也可以是动态的模板参数引用
|
tag_value |
否 |
Object |
参数说明：标签值，可以是一个明确的静态字符串，也可以是动态的模板参数引用
|
