华为云用户手册

响应参数 状态码： 201 表11 响应Body参数 参数 参数类型 描述 edge_node_id String 边缘节点ID 最小长度：1 最大长度：64 name String 边缘节点名称 最小长度：1 最大长度：64 instance_id String 实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。 最小长度：1 最大长度：36 space_id String 资源空间id，对应IOTDA云服务接口参数中的app_id。 最小长度：1 最大长度：64 product_id String 边缘节点关联的产品ID，用于唯一标识一个产品模型。 最小长度：1 最大长度：36 product_name String 边缘节点关联的产品名称。 最小长度：1 最大长度：64 state String 边缘节点状态UNINSTALLED|INSTALLED|OFFLINE|ONLINE|DELETING|FROZEN 最小长度：4 最大长度：32 type String 边缘节点类型：lite|advanced|standard。lite表示基础版边缘节点，advanced或standard表示专业版边缘节点。 最小长度：4 最大长度：16 installer_version String 安装文件版本 最小长度：1 最大长度：64 base_path BasePathDTO object 节点根目录配置 resource_ids Array of strings 资源id列表，创建节点时需绑定已购买的资源包，可以叠加节点功能。 最小长度：1 最大长度：64 ips Array of strings 边缘节点ip列表 数组长度：0 - 10 create_time String 边缘节点创建时间 最小长度：0 最大长度：256 hardware_model String 注册节点网关配置 最小长度：0 最大长度：1024 device_data_format String 节点使用的数据格式，默认为iotda物模型1.0格式，可以选择属性平铺数据格式flat_json 最小长度：0 最大长度：16 automatic_upgrade String 自动升级系统应用的节点开关，默认为关闭：OFF，IMMEDIATE表示节点开关打开 最小长度：0 最大长度：16 device_data_record DeviceDataRecord object 边缘节点设备数据上报打印配置 metric_report String omagent监控运维工具是否上报指标 最小长度：0 最大长度：16 iotda_south_access String iotda南向接入地址 最小长度：0 最大长度：128 os_type String 边缘节点系统类型。包括：generalLinux通用系统，openHarmony鸿蒙系统。 缺省值：generalLinux 最小长度：2 最大长度：32 表12 BasePathDTO 参数 参数类型 描述 log_base_path String 节点日志根目录 最小长度：1 最大长度：64 config_base_path String 节点配置根目录 最小长度：1 最大长度：64 db_base_path String 节点数据存储根目录 最小长度：1 最大长度：64 表13 DeviceDataRecord 参数 参数类型 描述 disk_quota Integer 磁盘配额，单位MB，参考值，只能保证在这个值左右 最小值：512 最大值：10240 缺省值：512 age Integer 老化时间，日志压缩文件名时间戳老于这个时间就会发生老化删除 最小值：1 最大值：7 缺省值：1 state String 配置开关，true启用数据打印，false不启用数据打印 最小长度：0 最大长度：16

请求示例 GET https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/points{ "point_id" : "MotorVoltage", "name" : "马达电压", "data_type" : "int", "collection_config" : { "address" : "ns=2;s=Root/Motor/Voltage", "data_type" : "int", "cycle" : 10000 }, "device_id" : "MotorVoltage", "property" : "Motor/Voltage", "processing_config" : { "validity" : { "min" : 60, "max" : 100 }, "stream_formula" : "bit(0).bool()|string_to_double(-1.0)|string_to_int(0)", "scaling" : { "ratio" : 1, "base" : 100, "accuracy" : 2 }, "clean" : { "silent_window" : 60, "deviation" : 0.1 } }}

响应参数 状态码： 201 表8 响应Body参数 参数 参数类型 描述 point_id String 点位表id，数据源下唯一 最小长度：1 最大长度：64 name String 点位名称，允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符 最小长度：1 最大长度：64 collection_config Object 点位采集配置 device_id String 设备id property String 属性，允许中、数字、英文大小写、下划线、中划线 最小长度：1 最大长度：128 data_type String 点位数据类型 最小长度：1 最大长度：32 ds_id String 采集数据源id，节点下唯一 最小长度：1 最大长度：64 processing_config ProcessingConfigDTO object 点位处理配置 create_time String 创建时间 最小长度：0 最大长度：256 update_time String 最后一次修改时间 最小长度：0 最大长度：256 表9 ProcessingConfigDTO 参数 参数类型 描述 validity PointValidityingDTO object 点位校验 stream_formula String 点位流公式配置字段 最小长度：0 最大长度：128 scaling PointScalingDTO object 点位缩放规则列表 clean PointCleanDTO object 点位计算规则列表 表10 PointValidityingDTO 参数 参数类型 描述 min Object 点位上报值的最小值，小于该值则上报告警 max Object 点位上报值的最大值，大于该值则上报告警 outlier_filtering Boolean 异常值过滤 表11 PointScalingDTO 参数 参数类型 描述 ratio Double 缩放的倍率 最小值：-10000 最大值：10000 base Double 基准值 最小值：-10000 最大值：10000 accuracy Integer 缩放后结果的精度，精确到小数点后几位,-1表示全部保留，0表示只保留整数位 最小值：-1 最大值：8 缺省值：-1 表12 PointCleanDTO 参数 参数类型 描述 silent_window Integer 静默时间窗口，在该时间窗口内，没有触发上报条件，点位将不会上 最小值：0 最大值：86400 deviation Double 偏差，在该偏差范围内表示是正常波动，点位将不进行上报 最小值：0 最大值：100

响应示例 状态码： 201 Created { "point_id" : "MotorVoltage", "name" : "马达电压", "collection_config" : { "address" : "ns=2;s=Root/Motor/Voltage", "data_type" : "int", "cycle" : 10000 }, "device_id" : "MotorVoltage", "property" : "Motor/Voltage", "data_type" : "int", "ds_id" : "opcua_1", "processing_config" : { "validity" : { "min" : 60, "max" : 100 }, "stream_formula" : "bit(0).bool()|string_to_double(-1.0)|string_to_int(0)", "scaling" : { "ratio" : 1, "base" : 100, "accuracy" : 2 }, "clean" : { "silent_window" : 60, "deviation" : 0.1 } }, "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z"}

URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/points 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。 最小长度：1 最大长度：64

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 point_id 是 String 点位表id，数据源下唯一 最小长度：1 最大长度：64 name 是 String 点位名称，允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符 最小长度：1 最大长度：64 data_type 否 String 点位数据类型 最小长度：1 最大长度：32 collection_config 是 Object 点位采集配置 device_id 是 String 设备id property 是 String 属性，允许中、数字、英文大小写、下划线、中划线 最小长度：0 最大长度：128 processing_config 否 ProcessingConfigDTO object 点位处理配置 表4 ProcessingConfigDTO 参数 是否必选 参数类型 描述 validity 否 PointValidityingDTO object 点位校验 stream_formula 否 String 点位流公式配置字段 最小长度：0 最大长度：128 scaling 否 PointScalingDTO object 点位缩放规则列表 clean 否 PointCleanDTO object 点位计算规则列表 表5 PointValidityingDTO 参数 是否必选 参数类型 描述 min 是 Object 点位上报值的最小值，小于该值则上报告警 max 是 Object 点位上报值的最大值，大于该值则上报告警 outlier_filtering 否 Boolean 异常值过滤 表6 PointScalingDTO 参数 是否必选 参数类型 描述 ratio 是 Double 缩放的倍率 最小值：-10000 最大值：10000 base 是 Double 基准值 最小值：-10000 最大值：10000 accuracy 否 Integer 缩放后结果的精度，精确到小数点后几位,-1表示全部保留，0表示只保留整数位 最小值：-1 最大值：8 缺省值：-1 表7 PointCleanDTO 参数 是否必选 参数类型 描述 silent_window 是 Integer 静默时间窗口，在该时间窗口内，没有触发上报条件，点位将不会上 最小值：0 最大值：86400 deviation 是 Double 偏差，在该偏差范围内表示是正常波动，点位将不进行上报 最小值：0 最大值：100

请求示例 POST https://{endpoint}/v2/{project_id}/edge-apps/{edge_app_id}/versions{ "version" : "1.0.0", "description" : "string", "sdk_version" : "string", "deploy_type" : "docker", "deploy_multi_instance" : false, "container_settings" : { "configs" : { "privileged" : false, "host_network" : true, "restart_policy" : "string", "container_port_list" : [ { "container_port" : 65535, "host_port" : 65535, "host_ip" : "string" } ] }, "image_url" : "string", "envs" : { }, "volumes" : [ { "name" : "string", "type" : "string", "source" : "string", "destination" : "string", "read_only" : true } ], "npu_type" : "D310", "resources" : { "limits" : { "cpu" : 1000, "memory" : 1024000, "gpu" : 1024000, "npu" : 1000 }, "requests" : { "cpu" : 1000, "memory" : 1024000, "gpu" : 1024000, "npu" : 1000 } }, "ext_devices" : [ { "source" : "string", "destination" : "string", "cgroup_permissions" : "string" } ] }, "liveness_probe" : { "exec_command" : "string", "tcp_socket" : { "port" : 65535 }, "http_get" : { "path" : "string", "port" : 65535, "host" : "string", "scheme" : "HTTP" }, "initial_delay_seconds" : 3600, "timeout_seconds" : 3600, "period_seconds" : 30, "failure_threshold" : 3 }, "readiness_probe" : { "exec_command" : "string", "tcp_socket" : { "port" : 65535 }, "http_get" : { "path" : "string", "port" : 65535, "host" : "string", "scheme" : "HTTP" }, "initial_delay_seconds" : 3600, "timeout_seconds" : 3600, "period_seconds" : 30, "failure_threshold" : 3 }, "arch" : { }, "command" : { }, "args" : { }, "outputs" : { }, "inputs" : { }, "services" : { }, "supplier" : "华为", "tpl_id" : "sys_general_opcua"}

响应示例 状态码： 201 Created { "edge_app_id" : "string", "name" : "string", "deploy_type" : "string", "deploy_multi_instance" : false, "version" : "string", "sdk_version" : "string", "description" : "string", "create_time" : "string", "update_time" : "string", "state" : "DRAFT", "liveness_probe" : { "exec_command" : "string", "tcp_socket" : { "port" : 65535 }, "http_get" : { "path" : "string", "port" : 65535, "host" : "string", "scheme" : "HTTP" }, "initial_delay_seconds" : 3600, "timeout_seconds" : 3600, "period_seconds" : 30, "failure_threshold" : 3 }, "readiness_probe" : { "exec_command" : "string", "tcp_socket" : { "port" : 65535 }, "http_get" : { "path" : "string", "port" : 65535, "host" : "string", "scheme" : "HTTP" }, "initial_delay_seconds" : 3600, "timeout_seconds" : 3600, "period_seconds" : 30, "failure_threshold" : 3 }, "arch" : "string", "command" : "string", "args" : "string", "container_settings" : { "configs" : { "privileged" : false, "host_network" : true, "restart_policy" : "string", "container_port_list" : { "container_port" : 65535, "host_port" : 65535, "host_ip" : "string" } }, "image_url" : "string", "envs" : { }, "volumes" : { "name" : "string", "type" : "string", "source" : "string", "destination" : "string", "read_only" : true }, "resources" : { "limits" : { "cpu" : 1000, "memory" : 1024000, "gpu" : 1024000, "npu" : 1000 }, "requests" : { "cpu" : 1000, "memory" : 1024000, "gpu" : 1024000, "npu" : 1000 } }, "ext_devices" : { "source" : "string", "destination" : "string", "cgroup_permissions" : "string" } }, "outputs" : "string", "inputs" : "string", "services" : "string", "publish_time" : { }, "off_shelf_time" : { }, "supplier" : "华为", "tpl_id" : "sys_general_opcua"}

响应参数 状态码： 201 表14 响应Body参数 参数 参数类型 描述 edge_app_id String 应用ID 最小长度：0 最大长度：32 name String 应用名称 最小长度：0 最大长度：64 deploy_type String 部署类型docker|process 最小长度：0 最大长度：64 deploy_multi_instance Boolean 是否允许部署多实例 缺省值：false version String 应用版本 最小长度：0 最大长度：32 sdk_version String 应用集成的边缘SDK版本 最小长度：1 最大长度：32 description String 应用描述 最小长度：0 最大长度：256 create_time String 创建时间 最小长度：0 最大长度：256 update_time String 最后一次修改时间 最小长度：0 最大长度：256 state String 应用版本状态 最小长度：0 最大长度：64 枚举值： DRAFT PUBLISHED OFF_SHELF liveness_probe ProbeDTO object 工作负载存活探针 readiness_probe ProbeDTO object 工作负载业务探针 arch Array of strings 架构 数组长度：1 - 1000000 command Array of strings 启动命令 数组长度：1 - 1000000 args Array of strings 启动参数 数组长度：1 - 1000000 container_settings ContainerSettingsDTO object 容器相关配置 outputs Array of strings 应用输出路由端点 数组长度：1 - 1000000 inputs Array of strings 应用输入路由 数组长度：1 - 1000000 services Array of strings 应用实现的服务列表 数组长度：1 - 1000 publish_time String 发布时间 最小长度：0 最大长度：256 off_shelf_time String 下线时间 最小长度：0 最大长度：256 supplier String 驱动厂商 最小长度：1 最大长度：128 tpl_id String 模板id 最小长度：1 最大长度：64 表15 ProbeDTO 参数 参数类型 描述 exec_command String 执行探测的命令行命令 最小长度：0 最大长度：256 tcp_socket TcpSocketDTO object 执行tcp探测 http_get HttpGetDTO object 执行http探测 initial_delay_seconds Integer 表示从工作负载启动后从多久开始探测 最小值：0 最大值：3600 timeout_seconds Integer 表示探测超时时间 最小值：1 最大值：3600 period_seconds Integer 检查周期 最小值：5 最大值：3600 缺省值：30 failure_threshold Integer 失败多少次算不健康 最小值：1 最大值：3600 缺省值：3 表16 TcpSocketDTO 参数 参数类型 描述 port Integer 端口 最小值：1 最大值：65535 表17 HttpGetDTO 参数 参数类型 描述 path String 请求路径 最小长度：2 最大长度：64 port Integer 端口 最小值：1 最大值：65535 host String 主机地址 最小长度：0 最大长度：64 scheme String 协议类型 最小长度：1 最大长度：64 枚举值： HTTP HTTPS 表18 ContainerSettingsDTO 参数 参数类型 描述 configs ContainerConfigsDTO object 容器特殊参数 image_url String 镜像存储地址 最小长度：1 最大长度：10000 envs Object 环境变量 volumes Array of VolumeDTO objects 卷配置 数组长度：0 - 40 npu_type String NPU类型 最小长度：0 最大长度：16 枚举值： D310 D910 D310P vnpu_template String NPU算力切分模板，可在对应芯片的机器上通过npu-smi info -t template-info命令查询其详细信息 最小长度：0 最大长度：32 枚举值： vir01 vir02 vir04 vir08 vir02_1c vir04_3c vir04_3c_ndvpp vir04_4c_dvpp resources ResourceDTO object 资源配额 ext_devices Array of ExtDevice objects 外挂设备配置 数组长度：0 - 1000000 表19 ContainerConfigsDTO 参数 参数类型 描述 privileged Boolean 开启容器特权模式 缺省值：false host_network Boolean 是否使用主机网络模式 缺省值：true restart_policy String 重启策略，容器执行健康检查后失败后的策略 最小长度：1 最大长度：256 container_port_list Array of ContainerPortDTO objects 容器端口映射值 数组长度：0 - 1000000 表20 ContainerPortDTO 参数 参数类型 描述 container_port Integer 构成一堆映射的容器端口 最小值：1 最大值：65535 host_port Integer 构成一对映射的物理机对应网卡端口 最小值：1 最大值：65535 host_ip String 对应网卡地址 最小长度：0 最大长度：64 表21 VolumeDTO 参数 参数类型 描述 name String 卷名称 最小长度：1 最大长度：63 type String 挂载类型 source String 源路径 destination String 卷挂载路径 read_only Boolean 只读，默认只读 表22 ResourceDTO 参数 参数类型 描述 limits ResourceConfigDTO object 允许容器使用的最大资源 requests ResourceConfigDTO object 容器需要使用的最小资源 表23 ResourceConfigDTO 参数 参数类型 描述 cpu Float cpu个数 最小值：0.01 最大值：1000 memory Float 内存大小 最小值：0.01 最大值：1024000 gpu Float gpu内存大小，单位为M 最小值：0.01 最大值：1024000 npu Float 使用npu加速卡个数 最小值：0.01 最大值：1000 表24 ExtDevice 参数 参数类型 描述 source String 源路径 destination String 卷挂载路径 cgroup_permissions String 只读，默认MRW

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 version 是 String 应用版本 最小长度：1 最大长度：32 description 否 String 应用描述 最小长度：0 最大长度：255 sdk_version 否 String 应用集成的边缘SDK版本 最小长度：1 最大长度：32 deploy_type 否 String 应用部署类型，分为docker容器部署类型和process进程部署类型，兼容之前数据，此字段可以为空，为空情况为docker类型 最小长度：0 最大长度：64 枚举值： docker process deploy_multi_instance 否 Boolean 是否允许部署多实例 缺省值：false container_settings 是 ContainerSettingsDTO object 容器相关配置 liveness_probe 否 ProbeDTO object 工作负载存活探针 readiness_probe 否 ProbeDTO object 工作负载业务探针 arch 是 Object 架构 command 否 Object 启动命令 args 否 Object 启动参数 outputs 否 Object 应用输出路由端点 inputs 否 Object 应用输入路由 services 否 Object 应用实现的服务列表 supplier 否 String 驱动厂商 最小长度：1 最大长度：128 tpl_id 否 String 模板id 最小长度：1 最大长度：64 表4 ContainerSettingsDTO 参数 是否必选 参数类型 描述 configs 否 ContainerConfigsDTO object 容器特殊参数 image_url 是 String 镜像存储地址 最小长度：1 最大长度：10000 envs 否 Object 环境变量 volumes 否 Array of VolumeDTO objects 卷配置 数组长度：0 - 40 npu_type 否 String NPU类型 最小长度：0 最大长度：16 枚举值： D310 D910 D310P vnpu_template 否 String NPU算力切分模板，可在对应芯片的机器上通过npu-smi info -t template-info命令查询其详细信息 最小长度：0 最大长度：32 枚举值： vir01 vir02 vir04 vir08 vir02_1c vir04_3c vir04_3c_ndvpp vir04_4c_dvpp resources 否 ResourceDTO object 资源配额 ext_devices 否 Array of ExtDevice objects 外挂设备配置 数组长度：0 - 1000000 表5 ContainerConfigsDTO 参数 是否必选 参数类型 描述 privileged 否 Boolean 开启容器特权模式 缺省值：false host_network 否 Boolean 是否使用主机网络模式 缺省值：true restart_policy 是 String 重启策略，容器执行健康检查后失败后的策略 最小长度：1 最大长度：256 container_port_list 否 Array of ContainerPortDTO objects 容器端口映射值 数组长度：0 - 1000000 表6 ContainerPortDTO 参数 是否必选 参数类型 描述 container_port 否 Integer 构成一堆映射的容器端口 最小值：1 最大值：65535 host_port 否 Integer 构成一对映射的物理机对应网卡端口 最小值：1 最大值：65535 host_ip 否 String 对应网卡地址 最小长度：0 最大长度：64 表7 VolumeDTO 参数 是否必选 参数类型 描述 name 是 String 卷名称 最小长度：1 最大长度：63 type 否 String 挂载类型 source 是 String 源路径 destination 是 String 卷挂载路径 read_only 否 Boolean 只读，默认只读 表8 ResourceDTO 参数 是否必选 参数类型 描述 limits 否 ResourceConfigDTO object 允许容器使用的最大资源 requests 否 ResourceConfigDTO object 容器需要使用的最小资源 表9 ResourceConfigDTO 参数 是否必选 参数类型 描述 cpu 否 Float cpu个数 最小值：0.01 最大值：1000 memory 否 Float 内存大小 最小值：0.01 最大值：1024000 gpu 否 Float gpu内存大小，单位为M 最小值：0.01 最大值：1024000 npu 否 Float 使用npu加速卡个数 最小值：0.01 最大值：1000 表10 ExtDevice 参数 是否必选 参数类型 描述 source 是 String 源路径 destination 是 String 卷挂载路径 cgroup_permissions 否 String 只读，默认MRW 表11 ProbeDTO 参数 是否必选 参数类型 描述 exec_command 否 String 执行探测的命令行命令 最小长度：0 最大长度：256 tcp_socket 否 TcpSocketDTO object 执行tcp探测 http_get 否 HttpGetDTO object 执行http探测 initial_delay_seconds 是 Integer 表示从工作负载启动后从多久开始探测 最小值：0 最大值：3600 timeout_seconds 是 Integer 表示探测超时时间 最小值：1 最大值：3600 period_seconds 否 Integer 检查周期 最小值：5 最大值：3600 缺省值：30 failure_threshold 否 Integer 失败多少次算不健康 最小值：1 最大值：3600 缺省值：3 表12 TcpSocketDTO 参数 是否必选 参数类型 描述 port 是 Integer 端口 最小值：1 最大值：65535 表13 HttpGetDTO 参数 是否必选 参数类型 描述 path 是 String 请求路径 最小长度：2 最大长度：64 port 是 Integer 端口 最小值：1 最大值：65535 host 否 String 主机地址 最小长度：0 最大长度：64 scheme 是 String 协议类型 最小长度：1 最大长度：64 枚举值： HTTP HTTPS

URI DELETE /v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 module_id 是 String 边缘模块ID 最小长度：1 最大长度：64

URI DELETE /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/points/{point_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。 最小长度：1 最大长度：64 point_id 是 String 采集点位表id，创建点位表时设置，数据源下唯一。 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 device_id 否 String 设备id property 否 String 设备服务属性，允许中、数字、英文大小写、下划线、中划线 最小长度：1 最大长度：128

响应示例 状态码： 201 create { "edge_app_id" : "test-app", "app_version" : "1.0.0", "state" : "PENDING", "control_status" : "0000000000000000", "node_id" : "test-node", "module_name" : "edge_module", "module_id" : "test-module-id", "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z", "app_type" : "SYSTEM_REQUIRED", "function_type" : "DATA_PRO CES SING", "container_settings" : { "configs" : { "container_port_list" : [ { "container_port" : 65535, "host_port" : 65535, "host_ip" : "string" } ] } }}

请求示例 POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/modules{ "edge_app_id" : "test-app", "app_version" : "1.0.0", "module_name" : "edge_module", "container_settings" : { "configs" : { "container_port_list" : [ { "container_port" : 65535, "host_port" : 65535, "host_ip" : "string" } ] } }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 edge_app_id 是 String 边缘应用名称 最小长度：0 最大长度：32 app_version 是 String 边缘应用版本 最小长度：0 最大长度：64 module_name 否 String 边缘模块名称 最小长度：0 最大长度：256 container_settings 否 ContainerSettingsReqDTO object 容器相关配置 表4 ContainerSettingsReqDTO 参数 是否必选 参数类型 描述 configs 否 ContainerConfigsReqDTO object 容器相关配置 custom_envs 否 Object 自定义环境变量 extra_hosts 否 Object 域名 解析配置集合 数组长度：0 - 20 表5 ContainerConfigsReqDTO 参数 是否必选 参数类型 描述 container_port_list 否 Array of ContainerPortDTO objects 容器端口映射值 数组长度：0 - 1000000 表6 ContainerPortDTO 参数 是否必选 参数类型 描述 container_port 否 Integer 构成一堆映射的容器端口 最小值：1 最大值：65535 host_port 否 Integer 构成一对映射的物理机对应网卡端口 最小值：1 最大值：65535 host_ip 否 String 对应网卡地址 最小长度：0 最大长度：64 表7 DNSConfigDTO 参数 是否必选 参数类型 描述 hostname 否 String 域名 最小长度：1 最大长度：1024 ip 否 String 域名解析对应IP 最小长度：1 最大长度：64

响应参数 状态码： 201 表8 响应Body参数 参数 参数类型 描述 edge_app_id String 应用ID 最小长度：0 最大长度：64 app_version String 应用版本 最小长度：0 最大长度：64 state String 模块运行状态 枚举值： PENDING PENDING_DELETE DELETE_FAILED RUNNING FAILED SUCCEEDED UNKNOWN DELETE_SUCCESS STOPPED control_status String 模块管控状态 node_id String 边缘节点（同deviceID）ID 最小长度：0 最大长度：64 module_name String 模块名称 最小长度：0 最大长度：256 module_id String 模块ID 最小长度：0 最大长度：64 create_time String 创建时间 最小长度：0 最大长度：256 update_time String 最后一次修改时间 最小长度：0 最大长度：256 app_type String 应用类型 枚举值： SYSTEM_REQUIRED SYSTEM_OPTIONAL USER function_type String 功能类型 枚举值： DATA_PROCESSING PROTOCOL_PARSING ON_PREMISE_INTEGRATION GATEWAY_MANAGER COMPOSITE_APPLICATION DATA_COLLECTION container_settings ModuleContainerSettingsResDTO object 容器相关配置 表9 ModuleContainerSettingsResDTO 参数 参数类型 描述 configs ContainerConfigsResDTO object 容器相关配置 custom_envs Object 自定义环境变量 extra_hosts Array of DNSConfigDTO objects 域名解析配置集合 数组长度：0 - 20 表10 ContainerConfigsResDTO 参数 参数类型 描述 host_network Boolean 是否使用主机网络模式 缺省值：false container_port_list Array of ContainerPortDTO objects 容器端口映射值 数组长度：0 - 1000000 表11 ContainerPortDTO 参数 参数类型 描述 container_port Integer 构成一堆映射的容器端口 最小值：1 最大值：65535 host_port Integer 构成一对映射的物理机对应网卡端口 最小值：1 最大值：65535 host_ip String 对应网卡地址 最小长度：0 最大长度：64 表12 DNSConfigDTO 参数 参数类型 描述 hostname String 域名 最小长度：1 最大长度：1024 ip String 域名解析对应IP 最小长度：1 最大长度：64

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 edge_app_id String 应用id 最小长度：1 最大长度：64 description String 应用描述 最小长度：0 最大长度：256 create_time String 创建时间 最小长度：0 最大长度：256 update_time String 最后一次修改时间 最小长度：0 最大长度：256 last_published_version String 最新发布版本 最小长度：0 最大长度：64 app_type String 应用类型SYSTEM_REQUIRED|SYSTEM_OPTIONAL|USER 最小长度：0 最大长度：64 function_type String 应用类型DATA_PROCESSING|PROTOCOL_PARSING 最小长度：0 最大长度：64 deploy_type String 部署类型docker|process 最小长度：0 最大长度：64 protocol String 驱动协议类型OPCUA|Modbus-TCP 最小长度：0 最大长度：64 edge_app_name String 应用名称 最小长度：0 最大长度：64

响应示例 状态码： 201 Created { "edge_app_id" : "string", "description" : "string", "create_time" : "string", "update_time" : "string", "last_published_version" : "string", "app_type" : "string", "function_type" : "string", "protocol" : "string", "edge_app_name" : "string", "deploy_type" : "string"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 edge_app_id 是 String 应用ID 最小长度：4 最大长度：32 edge_app_name 否 String 应用名称 最小长度：4 最大长度：64 description 否 String 应用描述 最小长度：0 最大长度：255 function_type 否 String 功能类型,分为数据处理（DATA_PROCESSING）、协议解析（PROTOCOL_PARSING）、IT集成（ON_PREMISE_INTEGRATION）和混合应用（COMPOSITE_APPLICATION），数据默认为DATA_PROCESSING，数据处理模块可以传输消息，协议解析为驱动类型，IT集成为部署南向3rdIA使用，混合应用可同时实现数据处理和协议解析。 最小长度：0 最大长度：255 枚举值： DATA_PROCESSING PROTOCOL_PARSING ON_PREMISE_INTEGRATION GATEWAY_MANAGER COMPOSITE_APPLICATION DATA_COLLECTION protocol 否 String 驱动协议类型OPCUA|Modbus-TCP 最小长度：0 最大长度：64

URI DELETE /v2/{project_id}/edge-nodes/{edge_node_id}/schedules/{schedule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 schedule_id 是 String 调度计划id 最小长度：1 最大长度：64

SDK下载 资源包名 描述 语言版本 版本 下载路径 Module SDK Module SDK是开发边缘运行应用（插件）所必须的工具包，提供数据处理、协议转换、IT子系统接入等功能，开发完成后，通过选择打包方式来决定是容器化部署还是进程化部署。 Java版 2.2.7.Release ModuleSDK_Java C版 / ModuleSDK_C_latest(包括x86_64, arm32, arm64版本,下载后解压选择对应版本) C#版 1.0.7 ModuleSDK_ CS harp

JAVA版SDK SDK获取和安装 1. 安装Java开发环境。 访问Java官网，下载并说明安装Java开发环境。 华为云Java SDK支持Java JDK 1.8 及其以上版本。 2. 使用eclipse/IDEA创建工程。 3. 下载ModuleSDK，并在工程中导入jar包。 4. 开发代码 开发数据处理的代码示例，详细说明请参考开发应用集成ModuleSDK进行数据处理。 /** * 监控APP，检视设备上报的数据，并对设备进行相应的控制 */public class MonitorApp implements BusMessageCallback { /** * 接收设备数据的消息总线输入点，取值需在创建应用版本的inputs参数中定义 */ private static final String INPUT = "input"; /** * 发送设备数据的消息总线输出点，取值需在创建应用版本的outputs参数中定义 */ public static final String OUTPUT = "output"; public static final int FIVE_SECOND = 5000; /** * 电机设备的产品ID */ public static final String MOTOR_PRODUCT_ID = "6b4843db3f0189e9c577"; /** * 与EdgeHub通信的客户端 */ private AppClient appClient; public MonitorApp() throws GeneraException { appClient = AppClient.createFromEnv(); } public void start() throws GeneraException { //设置回调，打开客户端 appClient.setBusMessageCallback(INPUT, this);//设置收到设备数据的回调 appClient.open(); } public void stop() throws GeneraException { appClient.close(); } /** * 收到设备上报数据的回调处理，样例代码在马达设备状态错误时对马达进行重启 * * @param busMessage */ @Override public void onMessageReceived(BusMessage busMessage) { try { if (busMessage.getProductId().equals(MOTOR_PRODUCT_ID)) { //马达设备状态错误时对马达进行重启 MotorData motorData = JsonUtil.fromJson( JsonUtil.toJson(busMessage.getServices().get(0).getProperties()), MotorData.class); if (motorData.getStatus().equals("error")) { Command command = new Command(busMessage.getDeviceId(), "power", "restart", null); appClient.callDeviceCommand(command, FIVE_SECOND); }else{ //其他设备数据发布到总线 appClient.sendBusMessage(OUTPUT, busMessage); } } else { //其他设备数据发布到总线 appClient.sendBusMessage(OUTPUT, busMessage); } } catch (Exception e) { System.out.println(e.getMessage()); } }}

IoTEdge与IEF的关系和区别是什么？ IoTEdge是一组软件产品，包含云服务、边缘运行时软件、边缘模块应用，将云端能力快速拓展至边缘，提供数据采集、低时延自治、云边协同、边缘计算等能力，在园区、城市、工业等场景，作为数据源切入点，解决客户对设备上云、本地计算、数据预处理等诉求。IoTEdge支持进程级应用部署、容器化应用部署、Helm应用模板部署，提供基础版、专业版、企业版，三种运行引擎。其中基础版可以部署在Linux系统或OpenHarmony系统的轻量级网关上，专业版可以部署在Docker环境的网关或服务器上，企业版可以部署在边缘服务器集群上，自带Kubernetes。IEF基于开源框架KubeEdge开发，提供容器化应用部署能力，具备Kubernetes的集群管理能力。IoTEdge专业版兼容IEF部署底座。 父主题： 概念相关

边缘节点和子设备均在线，为什么子设备上报的数据在IoTDA平台查看不到？ 查看EdgeHub日志（专业版节点日志路径：/var/IoTEdge/log/sys_edge_hub/log/edge-hub-running.log；专业版节点日志路径：/var/IEF/app/log/sys_edge_hub/log/edge-hub-running.log），触发子设备数据上报时，查看日志内容是否有异常信息。 若日志提示“No services”，为该设备上报的数据与设备产品的serviceId对应不上。当前边缘节点不感知产品的更新。若新建一个空白的设备产品，为边缘节点创建子设备，然后修改设备产品新增服务和属性，则此时设备上报数据中的服务属性在边缘节点无感知，即会出现“No services”的异常。 当进行基于IoT边缘实现模拟MQTT设备的快速接入实践，添加边缘设备时，误操作填写了模块ID后，导致数据无法上报，删除边缘设备后重新添加。模块ID的设置代表设备接入点为该模块；空代表设备接入点为设备自身，相当于网关。 父主题： 子设备管理

创建应用版本时，如何添加自定义命令？ 方法一： 1. 通过docker run 命令将应用容器运行起来; docker run [OPTIONS] IMAGE [COMMAND] [ARG...] 2. 将[COMMAND]填入到运行命令处，[ARG...]填入到命令参数中，参数有多个时，参考输入框中的提示，以换行进行分隔。 3. [OPTIONS] 中相关配置根据具体配置内容在高级配置中选填。 方法二： 1. 通过docker run 命令将应用容器运行起来; 2. 使用docker ps -a 查看运行的应用容器ID； 3. 通过docker inspect [CONTAINER ID]查看容器详细信息；将Cmd中的内容填至参数列表，将Entrypoint中的内容填至运行命令处，为null则不填 将应用版本部署到边缘之后如果出现容器无法运行、退出等问题，需要保证其他的配置正确。（如配置了挂载卷，但是没有设置访问权限）。 父主题： 应用管理

专业版节点所在机器断网/断电一段时间后恢复，节点模块一直处于“部署中”怎么处理？ 在IEF控制台检查对应节点的状态是否为在线。 若IEF节点状态为在线，检查IEF节点下容器应用的状态是否为“异常”；可“创建容器应用”查看是否能正常部署应用。 若IEF节点状态为“故障”，或IEF节点无法创建容器应用，则需通过工单联系IEF技术专家协助定位。 若IEF节点可以正常部署容器应用，且部署的应用可正常运行，则需通过工单联系IoTEdge技术专家协助定位。 父主题： 节点管理

安装边缘节点 在网关或服务器上安装docker，安装docker参考安装docker官方教程。 在“边缘节点”的节点列表选择您需要安装的节点，单击右侧“安装”，获得提示。 图4 安装节点 选择支持架构和安装目录，然后单击复制安装命令，使用SSH工具以root用户登录边缘节点服务器后台系统，执行安装命令。 图5 获取安装命令 安装命令的选择需要与购买的ecs的架构保持一致。 图6 执行安装 图7 安装命令执行成功 边缘节点的状态变为“在线”，表示该节点已安装并连接成功。 单击“节点名称”，查看该节点详细信息，关于节点详情描述可参见基本信息。

业务流程 IoT边缘基于 物联网平台 的 设备接入服务 ，给您提供边缘侧设备接入、低时延业务联动和本地闭环管理的解决方案。 使用IoT边缘服务的关键流程如下： 图1 业务流程 序号 步骤 步骤说明 1 购买边缘节点硬件 边缘节点硬件需要满足一定的规格要求。 购买边缘节点后，联系技术支持进行边缘节点组网配置。 2 开通IoT边缘服务、IoTDA设备接入服务等 IoT边缘使用时，需要依赖IoTDA设备接入服务提供针对边缘节点和节点下的设备的完整的设备接入和设备管理能力，在使用IoT边缘服务之前，需自行开通设备接入（IoTDA）服务。 3 注册边缘节点 在IoT边缘服务的控制台注册边缘节点，平台自动生成安装命令。 4 安装边缘软件 在边缘节点硬件上执行安装命令，完成对边缘节点的安装。安装完成后，边缘节点将作为设备自动连接到IoTDA设备接入服务。 5 部署应用模块 在IoT边缘服务的控制台上部署应用。边缘节点将自动从云端下载IoT边缘镜像，并部署到边缘节点中。 6 购买数采服务（可选） 在IoT边缘服务的控制台，购买数采资源包。 7 数据采集对接 将数据采集应用从云端下发部署到边缘节点中，对其进行数采配置并下发，将边缘节点硬件与近场设备对接（有线或无线），解析设备协议进行数据采集。详情可参考基于IoT边缘实现OT数采（OPCUA协议）。 8 设备数据上报 将采集到的数据，从边缘节点上报到IoTDA设备接入服务。

各手机厂商视频类智能信息模板差异 各手机厂商支持内容的差异 支持情况及规范要求参见表1 表1 各手机厂商视频类智能信息模板支持内容的差异 品牌 华为 小米 OPPO VIVO 魅族 视频类模板素材规范 视频 格式 MP4 / MP4 MP4、TS / 尺寸 16：9 16：9 16：9 大小 10M 25M 无限制 标题 1行，17字 1行，17字 2行，30字 正文 3行，69字 3行，69字 2行，69字 按钮 1个，15字 1个，15字 1行，7字 动参能力 √ / √ √ / 各手机厂商视频类智能信息模板终端样例差异 图1 华为终端样例 图2 VIVO终端样例 图3 OPPO终端样例

各手机厂商智能信息支持能力差异有哪些？ 表1 各手机厂商智能信息支持能力 各手机厂商智能信息支持能力一览表 华为 小米 OPPO VIVO 魅族 点击事件 打开H5 √ √ √ √ √ 打开浏览器 √ √ √ √ √ 打开快应用 √ √ √ √ √ 打开app √ √ √ √ √ 打电话 √ √ × × √ 发短信 √ √ × × √ 发邮件 √ √ × × √ 设置日程 √ √ × × √ 打开地图 √ √ × × √ 弹窗 √ √ × × √ 复制 √ √ × × √ 查看大图 √ √ √ √ × 短链能力 个性化短链 √ √ √ √ √ 群发短链 √ √ √ √ √ 识别类型 短链识别 √ √ √ √ √ 特征码识别 √ × × × × 文本识别 √ × √ √ × 动参能力 文本动参 √ √ √ × × 兜底能力 打开应用市场 √ √ √ √ × 打开H5 √ √ √ √ × 打开浏览器 √ √ √ √ × 打开快应用 √ √ × × × 父主题： 智能模板制作常见问题