设备接入 IoTDA设备接入 IoTDA

计算
弹性云服务器 ECS
裸金属服务器 BMS
云手机 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器 HECS
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属企业存储服务
云存储网关 CSG
专属分布式存储服务 DSS
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘小站 IES
智能边缘平台 IEF
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
园区智能体 CampusGo
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
语音交互服务 SIS
知识图谱 KG
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
设备管理 IoTDM(联通用户专用)
全球SIM联接 GSL
IoT数据分析
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
开发与运维
软件开发平台 DevCloud
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
开源镜像站 Mirrors
应用魔方 AppCube
云性能测试服务 CPTS
应用管理与运维平台 ServiceStage
云应用引擎 CAE
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
区块链
区块链服务 BCS
可信跨链服务 TCS
可信分布式身份服务
智能协作
IdeaHub
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
云生态
云市场
合作伙伴中心
华为云培训中心
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
云原生服务中心 OSC
容器批量计算 BCE
容器交付流水线 ContainerOps
应用服务网格 ASM
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB (for openGauss)
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
数据管理服务 DAS
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据湖治理中心 DGC
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
API网关 APIG
分布式缓存服务 DCS
分布式消息服务RocketMQ版
企业应用
域名注册服务 Domains
云解析服务 DNS
云速建站 CloudSite
网站备案
商标注册
华为云WeLink
会议
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
API全生命周期管理 ROMA API
安全与合规
安全技术与应用
DDoS防护 ADS
Web应用防火墙 WAF
云防火墙 CFW
应用信任中心 ATC
企业主机安全 HSS
容器安全服务 CGS
云堡垒机 CBH
数据库安全服务 DBSS
数据加密服务 DEW
数据安全中心 DSC
云证书管理服务 CCM
SSL证书管理 SCM
漏洞扫描服务 VSS
态势感知 SA
威胁检测服务 MTD
管理检测与响应 MDR
安全治理云图 Compass
认证测试中心 CTC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
专属云
专属计算集群 DCC
解决方案
高性能计算 HPC
SAP
混合云灾备
华为工业云平台 IMC
价格
成本优化最佳实践
专属云商业逻辑
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
更新时间:2022-01-14 GMT+08:00
分享

创建自定义策略函数

了解函数接口定义

函数服务对函数有明确的接口定义。

以java语言为例,接口定义为:作用域 返回参数 函数名(函数参数,Context参数)

  • 作用域:提供给FunctionGraph调用的用户函数必须定义为public。
  • 返回参数:用户定义,FunctionGraph负责转换为字符串,作为HTTP Response返回。对于返回参数对象类型,HTTP Response该类型的JSON字符串。
  • 函数名:用户定义函数名称。
  • 用户定义参数:当前函数只支持一个用户参数。对于复杂参数,建议定义为对象类型,以JSON字符串提供数据。FunctionGraph调用函数时,解析JSON为对象。
  • Context参数:runtime提供函数执行上下文,其接口定义在SDK接口说明。

创建Java函数时,函数入口参数需要提供函数完整的名字空间,参数格式为:包名.类名.函数名。

设备发放在此基础上,要求函数代码满足如下条件:

编写自定义函数

  1. 创建函数工程,编写函数。

    首先建立一个普通的Java项目,添加FunctionGraph函数JavaSDK为工程依赖,可下载设备发放提供函数Demo,参照Demo创建工程编写函数。

    FunctionGraph函数JavaSDK提供了Event事件接口、Context接口和日志记录接口。其中Runtime-x.x.x.jar包含了函数执行上下文,其他Jar包为附带的第三方库,可按需添加。

    Java函数开发指南参见函数工作流 FunctionGraph > 开发指南 > 如何开发函数 > Java函数开发指南

    参照如下代码编写函数,实现必要逻辑。

    package com.huawei.demo;
     
    import com.huawei.demo.common.logger.DefaultLogger;
    import com.huawei.demo.model.AccessPointPara;
    import com.huawei.demo.model.FunctionGraphPara;
    import com.huawei.demo.model.TdpFuncResult;
    import com.huawei.services.runtime.Context;
     
    import java.util.Optional;
     
    /**
     * 实现该类。
     * WARNING:{@link #apiHandle(FunctionGraphPara, Context)} 该方法必须在子类中定义,否则函数无法触发该函数接口!!!
     * <pre>
     * {@code
     *     @Override
     *     public TdpFuncResult apiHandle(FunctionGraphPara para, Context context) {
     *         return super.apiHandle(para, context);
     *     }
     * }
     * </pre>
     */
    public abstract class TdpFunction {
        protected static final DefaultLogger LOGGER = new DefaultLogger(TdpFunction.class);
     
        /**
         * 函数定义
         */
        public TdpFuncResult apiHandle(FunctionGraphPara para, Context context) {
            // 获取日志
            DefaultLogger.init(Optional.ofNullable(context)
                .map(Context::getLogger)
                .orElse(null));
     
            // 校验入参
            TdpFuncResult result = checkPara(para, context);
            if (result != null) {
                return result;
            }
     
            // 确定接入点
            AccessPointPara accessPointPara = determineAccessPoint(para);
     
            // 发放设备
            result = provisionDevice(para, accessPointPara);
     
            LOGGER.info("result:{}", result);
            return result;
        }
     
        /**
         * 校验入参
         */
        protected abstract TdpFuncResult checkPara(FunctionGraphPara para, Context context);
     
        /**
         * 从备选的接入点中选择合适的接入点
         */
        protected abstract AccessPointPara determineAccessPoint(FunctionGraphPara para);
     
        /**
         * 调用设备发放的发放接口发放设备
         */
        protected abstract TdpFuncResult provisionDevice(FunctionGraphPara para, AccessPointPara accessPointPara);
    }

  2. 打包函数,上传代码。

    函数打包规范参见函数工作流 FunctionGraph > 开发指南 > 概述 > 函数工程打包规范

    如函数工程未使用到第三方库,则可将工程打成一个Jar包上传。如使用到第三方库,则需将工程Jar包和第三方Jar包打包成一个Zip包。

    本文使用到了多个第三方库,因此,如下图所示,将工程Jar包和第三方Jar包打包成一个Zip包。

    进入函数工作流服务控制台,创建函数并上传包含工程Jar包和第三方Jar包的Zip包。

    为避免调试过程中函数因内存不足或超时导致调用失败,视实际使用情况调整内存大小和超时时间。

  3. 配置测试事件,调试函数。

    创建测试事件,填写满足设备发放约束的函数参数的JSON格式。

    点击“保存并测试”,查看函数运行结果,确认函数逻辑的正确性。

    日志显示,已调用了发放设备接口,函数主要逻辑正确。至此,您已完成自定义策略函数的编写,可进行后续步骤。

后续操作

完成自定义策略函数的编写后,创建关联该函数的自定义策略实例以及设备或注册组,通过设备南向操作触发函数,将设备发放到指定目的接入点(设备接入实例)。

后续操作包括:

最佳实践:

  • 结合函数服务通过自定义策略发放证书认证的设备。

设备发放对返回参数的约束

表1 TdpFuncResult

名称

说明

类型

statusCode

String

函数执行状态码,用于标识函数执行过程是否出现异常,遵循HTTP状态码含义。

body

String

字符串,但格式为JSON,结构为TdpFuncBody。

表2 TdpFuncBody

名称

说明

类型

status

String

设备发放业务功能标识,allow表示发放成功,deny表示发放失败,设备发放使用此标识判断函数内业务功能执行成功与否。

context

TdpFuncBodyContext

扩展字段,用于承载函数执行结果。

表3 TdpFuncBodyContext

名称

说明

类型

allocationResult

String

发放结果,存放发放接口返回的响应结构体。

errorCode

String

错误码,如发放失败,则此值需不为空。

errorMsg

String

错误描述,如发放失败,则此值需不为空。

发放设备成功的返回参数样例

{
  "statusCode": 200,
  "body": "{\"status\":\"allow\",\"context\":{\"allocationResult\":\"dps返回的下发结果\"}}"
}

发放设备失败的返回参数样例

{
  "statusCode": 200,
  "body": "{\"status\":\"deny\",\"context\":{\"errorCode\":\"错误码\",\"errorMsg\":\"错误描述\"}}"
}

设备发放对函数参数的约束

表4 FunctionGraphPara

名称

类型

说明

iamToken

String

委托Token,便于用户调用发放接口。

deviceId

String

设备ID。

deviceName

String

设备名称。

accessPoints

List<AccessPointPara>

备选接入点列表。

authInfo

AuthInfoPara

设备认证信息。

表5 AccessPointPara

名称

类型

说明

regionId

String

备选接入点的区域ID。

accessPointId

String

备选接入点的接入点ID。

authorizingDomainId

String

备选接入点的接入点授权租户,仅在授权场景下使用。

表6 AuthInfoPara

名称

类型

说明

authType

String

认证类型。可选 SECRET 和 CERTIFICATES。

secret

String

设备密钥信息,当认证类型为 SECRET 时携带。

certInfo

CertInfoPara

证书信息,当认证类型为 CERTIFICATES 时携带。

表7 CertInfoPara

名称

类型

说明

caCert

CaCertPara

设备CA证书信息。

deviceCert

List<DeviceCertPara>

设备证书信息。

表8 CaCertPara

名称

类型

说明

subjectCnName

String

证书使用者CN NAME。

caCertName

String

证书名。

fingerprint

String

证书指纹。

表9 DeviceCertPara

名称

类型

说明

subjectCnName

String

证书使用者CN NAME。

issuerCnName

String

证书颁发者CN NAME。

sha1Fingerprint

String

证书指纹(使用SHA-1算法计算)。

sha256Fingerprint

String

证书指纹(使用SHA-256算法计算)。

证书认证设备触发函数策略的函数参数样例

{
  "iamToken": "MIIT3gYJKoZIhvcNAQcCoIIT...",
  "deviceId": "testDeviceId",
  "deviceName": "testDeviceName",
  "accessPoints": [
    {
      "regionId": "cn-north-4",
      "accessPointId": "cn-north-4",
      "authorizingDomainId": null
    },
    {
      "regionId": "cn-north-4",
      "accessPointId": "86a45e59-3003-24b8-4e81-df0a9a694639",
      "authorizingDomainId": "84fd2c95ddf03b840f18100a000d45c2"
    }
  ],
  "authInfo": {
    "authType": "CERTIFICATES",
    "certInfo": {
      "caCert": {
        "subjectCnName": "serverCommonName20200922204814",
        "caCertName": "ca20200922204814",
        "fingerprint": "dc0f1016f495157344ac5f1296335cff725ef22f"
      },
      "deviceCert": [
        {
          "subjectCnName": "deviceCommonName20200922204814",
          "issuerCnName": "serverCommonName20200922204814",
          "sha1Fingerprint": "b2217bd882968b0bc15b1c2b132ba8a598f11879",
          "sha256Fingerprint": "734326bb5f3065d8e90d95ce1910b831d3856a1318770768bf9b03923d641ddd"
        }
      ]
    }
  }
}

密钥认证设备触发函数策略的函数参数样例

{
  "iamToken": "MIIT3gYJKoZIhvcNAQcCoIIT...",
  "deviceId": "testDeviceId",
  "deviceName": "testDeviceName",
  "accessPoints": [
    {
      "regionId": "cn-north-4",
      "accessPointId": "cn-north-4",
      "authorizingDomainId": null
    },
    {
      "regionId": "cn-north-4",
      "accessPointId": "86a45e59-3003-24b8-4e81-df0a9a694639",
      "authorizingDomainId": "84fd2c95ddf03b840f18100a000d45c2"
    }
  ],
  "authInfo": {
    "authType": "SECRET",
    "secret": "29ccf3ff01247d731fef"
  }
}
分享:

    相关文档

    相关产品

关闭导读