检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
说明。 创建Java函数时,函数入口参数需要提供函数完整的名字空间,参数格式为:包名.类名.函数名。 设备发放在此基础上,要求函数代码满足如下条件: 返回参数:需满足设备发放对返回参数的约束; 函数参数:需满足设备发放对函数参数的约束; 函数接口实现:从函数参数中的备选接入点中选
和其他服务的关系 设备发放服务与其他服务的关系如表1所示。 表1 与其他服务的关系列表 交互功能 相关服务 位置 创建设备时,需要使用设备接入服务创建的产品 设备接入服务(IoT Device Access,IoTDA) 创建产品 创建自定义策略时需要使用函数 函数工作流服务(FunctionGraph)
通过自定义策略发放设备功能流程图如下图所示。 函数开发 自定义策略的函数代码编写指南参见创建自定义策略函数。 此处以Java语言为例,如何编写Java语言的函数,参见函数工作流 FunctionGraph > 开发指南> 如何开发函数> Java函数开发指南。 创建函数工程,编写函数。 关键流程代码参考如下:
存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要
构造请求 本节介绍如何构造REST API的请求,并以调用IAM服务的获取用户Token为例说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过此视频了解如何构造请求调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme}
消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于查询接入点列表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”等。 对于查询接
100411 function urn not exist. 函数不存在 请填写正确的函数信息 400 IoTDP.100412 function urn is exist by this domain. 函数名已存在 请填写正确的函数信息 400 IoTDP.100413 strategy
从控制台获取项目ID 在调用接口时,部分URI以及请求体中需要填入项目ID,项目ID获取步骤如下: 在华为云首页右上角,点击“控制台”。 在右上角的用户名中选择“我的凭证”。 在“我的凭证”界面,API凭证页签中,查看项目ID。 调用API获取项目ID 项目ID还可以通过调用查询指定条件下的项目信息API获取。
进入“策略”界面,单击展开“自定义策略”,单击“添加函数”。 图1 添加自定义策略 按照下方参数说明填写关键参数信息后,单击“确定”。 参数名称 说明 示例 函数 即在函数服务中实现的自定义策略。如果下拉框没有你想要的函数,可以单击创建新函数来实现你的自定义策略需求。 将需要通过函数“function”发放的设备发放至华北-北京四的物联网平台。
删除设备 功能介绍 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。若设备已发放成功,此接口将级联删除设备接入实例中的该设备。 URI DELETE /v5/iotps/{project_id}/devices/{device_id}
查询设备列表 功能介绍 应用服务器可调用此接口查询物联网平台中的设备信息列表。 URI GET /v5/iotps/{project_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1 最大长度:32
与静态策略和证书策略相比,自定义策略为您提供更灵活的策略机制。自定义策略实例指示函数关联的设备接入实例,一个函数可关联多个设备接入实例。 设备匹配自定义策略实例的机制为: 设备的发放策略指定为“函数策略”时,需同时指定其关联的函数,设备与自定义策略实例关联同一个函数时,即被认为该设备匹配上该条策略实例; 一个设备可匹配多条自定义策略实例。
书ID为云证书服务生成的证书ID。 最小长度:0 最大长度:256 func_urn 否 String 函数的URN(Uniform Resource Name),唯一标识函数。 最小长度:1 最大长度:360 init_config 否 String 注册组的初始化配置。必须为json字符串
缺省值:functions function_name String 自定义函数名称。 最小长度:1 最大长度:256 func_urn String 函数的URN(Uniform Resource Name),唯一标识函数。 最小长度:1 最大长度:360 registration_group_id
FunctionStrategyReq 参数 是否必选 参数类型 描述 func_urn 是 String 函数的URN(Uniform Resource Name),唯一标识函数 最小长度:1 最大长度:360 响应参数 状态码: 200 表9 响应Body参数 参数 参数类型 描述
缺省值:functions function_name String 自定义函数名称。 最小长度:1 最大长度:256 func_urn String 函数的URN(Uniform Resource Name),唯一标识函数。 最小长度:1 最大长度:360 registration_group_id
书ID为云证书服务生成的证书ID。 最小长度:0 最大长度:256 func_urn 否 String 函数的URN(Uniform Resource Name),唯一标识函数。 最小长度:1 最大长度:360 auth_type 否 String 认证类型 register_group_secret
删除注册组 功能介绍 应用服务器可调用此接口在物联网平台上删除指定注册组。 URI DELETE /v5/iotps/{project_id}/registration-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。
D为云证书管理服务生成的证书ID。 最小长度:0 最大长度:256 func_urn 否 String 函数的URN(Uniform Resource Name),唯一标识函数。自定义策略下必填该字段。 最小长度:1 最大长度:360 bs_secret 否 String 引导服务端PSK。