华为云用户手册

  • IOT边缘 IOTEDGE-PATCH方法的代理:请求参数
    请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表4 请求Body参数 参数 是否必选 参数类型 描述 body 否 Object 第三方IA服务资源请求结构体
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-PATCH方法的代理:URI
    URI PATCH /v2/{project_id}/edge-nodes/{node_id}/ias/{ia_id}/api 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 node_id 是 String 边缘节点ID ia_id 是 String 第三方应用IA ID 表2 Query参数 参数 是否必选 参数类型 描述 ia_uri 是 String 第三方IA服务资源地址
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-批量确认南向3rdIA配置项:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 configs 否 Array of ConfirmIaConfigRequestBody objects 确认配置项列表 表4 ConfirmIaConfigRequestBody 参数 是否必选 参数类型 描述 id 是 String 配置项ID version 是 String 版本号
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-设备控制设置:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 control_id 是 String 控制id service_id 否 String 服务id，可选 priority 是 Integer 调度计划优先级。 end_time 否 Long 控制结束时间，毫秒级时间戳 properties 是 Object 属性key和value的map，用于设置属性的值
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-设备控制设置:URI
    URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/devices/{device_id}/controls/set 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID device_id 是 String 设备ID
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-查询北向NA信息详情:响应参数
    响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 na_id String NA系统ID，提供给其他系统访问的唯一标识 name String NA系统名称 description String 北向NA系统描述 endpoint String 访问URL地址 auth_type String 鉴权方式 access_type String 接入类型 access_roma_info AccessRomaBriefInfo object ROMA接入鉴权信息 create_time String 创建时间 update_time String 更新时间 表4 AccessRomaBriefInfo 参数 参数类型 描述 app_key String 认证key，加密存储
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-查询北向NA信息详情:响应示例
    响应示例 状态码：200 OK { "name" : "北向系统1", "description" : "这是一个北向NA", "endpoint" : "https://068b72f3b75444dda67cc6e2286a4c20.apic.cn-south-1.huaweicloudapis.com", "auth_type" : "AKSK", "access_type" : "ROMA", "access_roma_info" : { "app_key" : "ebf59208-4c6b-4b06-9b69-494e9df475a3" } }
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-使用前必读:概述
    概述 IoT边缘（IoTEdge）聚焦现场边缘，通过多引擎架构实现云边端协同，加速企业应用创新。IoT边缘平台作为云边协同管理平台，提供统一边缘管理中心和云边端协同引擎，支持纳管Kubernetes边缘集群与监控运维异构的边缘基础设施，为您提供低成本、本地自闭环、边缘智能、云边协同的软硬一体化方案。 您可以使用本文档提供API来使用IoT边缘平台的服务，包括北向NA管理、南向IA配置项管理、北向HTTP请求代理等，平台支持的全部API请参见API列表。 在调用IoT边缘平台API之前，请确保已经充分了解相关概念，详细信息请参见产品介绍。
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-查询应用版本列表:响应示例
    响应示例 状态码：200 OK { "count" : 0, "page_info" : { "offset" : 0, "limit" : 0 }, "versions" : [ { "edge_app_id" : "test-app", "version" : "1.0.0", "description" : "this is a test app", "deploy_type" : "string", "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z", "state" : "PUBLISHED", "arch" : [ null ], "publish_time" : "2020-05-28T11:31:29.740Z", "off_shelf_time" : "2020-05-28T11:31:29.740Z" } ] }
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-查询应用版本列表:URI
    URI GET /v2/{project_id}/edge-apps/{edge_app_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_app_id 是 String 应用版本,应用内版本唯一。 表2 Query参数 参数 是否必选 参数类型 描述 version 否 String 应用版本搜索关键字 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000 ai_card_type 否 String ai加速卡类型 arch 否 String 支持架构 state 否 String 应用版本状态 deploy_type 否 String 应用部署类型
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-查询应用版本列表:响应参数
    响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 page_info PageInfoDTO object 分页信息 versions Array of QueryEdgeAppVersionBriefResponseDTO objects 每页记录数 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 limit Integer 每页记录数 表6 QueryEdgeAppVersionBriefResponseDTO 参数 参数类型 描述 edge_app_id String 应用ID name String 应用名称 version String 应用名称 sdk_version String 应用集成的边缘SDK版本 description String 应用描述 deploy_type String 部署类型docker|process deploy_multi_instance Boolean 是否允许部署多实例 create_time String 创建时间 update_time String 最后一次修改时间 state String 应用版本状态 arch Array of strings 架构 publish_time String 发布时间 off_shelf_time String 下线时间
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-创建点位表配置:响应示例
    响应示例 状态码：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" }
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-创建点位表配置:响应参数
    响应参数 状态码：201 表8 响应Body参数 参数 参数类型 描述 point_id String 点位表id，数据源下唯一 name String 点位名称，允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符 collection_config Object 点位采集配置 device_id String 设备id property String 属性，允许中、数字、英文大小写、下划线、中划线 data_type String 点位数据类型 ds_id String 采集数据源id，节点下唯一 processing_config ProcessingConfigDTO object 点位处理配置 create_time String 创建时间 update_time String 最后一次修改时间 表9 ProcessingConfigDTO 参数 参数类型 描述 validity PointValidityingDTO object 点位校验 stream_formula String 点位流公式配置字段 scaling PointScalingDTO object 点位缩放规则列表 clean PointCleanDTO object 点位计算规则列表 表10 PointValidityingDTO 参数 参数类型 描述 min Object 点位上报值的最小值，小于该值则上报告警 max Object 点位上报值的最大值，大于该值则上报告警 outlier_filtering Boolean 异常值过滤 表11 PointScalingDTO 参数 参数类型 描述 ratio Double 缩放的倍率 base Double 基准值 accuracy Integer 缩放后结果的精度，精确到小数点后几位,-1表示全部保留，0表示只保留整数位 表12 PointCleanDTO 参数 参数类型 描述 silent_window Integer 静默时间窗口，在该时间窗口内，没有触发上报条件，点位将不会上 deviation Double 偏差，在该偏差范围内表示是正常波动，点位将不进行上报
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-创建点位表配置:请求示例
    请求示例 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 } } }
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-创建点位表配置:URI
    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 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-创建点位表配置:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 point_id 是 String 点位表id，数据源下唯一 name 是 String 点位名称，允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符 data_type 否 String 点位数据类型 collection_config 是 Object 点位采集配置 device_id 是 String 设备id property 是 String 属性，允许中、数字、英文大小写、下划线、中划线 processing_config 否 ProcessingConfigDTO object 点位处理配置 表4 ProcessingConfigDTO 参数 是否必选 参数类型 描述 validity 否 PointValidityingDTO object 点位校验 stream_formula 否 String 点位流公式配置字段 scaling 否 PointScalingDTO object 点位缩放规则列表 clean 否 PointCleanDTO object 点位计算规则列表 表5 PointValidityingDTO 参数 是否必选 参数类型 描述 min 是 Object 点位上报值的最小值，小于该值则上报告警 max 是 Object 点位上报值的最大值，大于该值则上报告警 outlier_filtering 否 Boolean 异常值过滤 表6 PointScalingDTO 参数 是否必选 参数类型 描述 ratio 是 Double 缩放的倍率 base 是 Double 基准值 accuracy 否 Integer 缩放后结果的精度，精确到小数点后几位,-1表示全部保留，0表示只保留整数位 表7 PointCleanDTO 参数 是否必选 参数类型 描述 silent_window 是 Integer 静默时间窗口，在该时间窗口内，没有触发上报条件，点位将不会上 deviation 是 Double 偏差，在该偏差范围内表示是正常波动，点位将不进行上报
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-查询边缘模块:响应示例
    响应示例 状态码：200 OK { "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" : { "host_network" : false, "container_port_list" : [ { "container_port" : 65535, "host_port" : 65535, "host_ip" : "string" } ] } } }
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-查询边缘模块:响应参数
    响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 edge_app_id String 应用ID app_version String 应用版本 state String 模块运行状态 control_status String 模块管控状态 node_id String 边缘节点（同deviceID）ID module_name String 模块名称 module_id String 模块ID create_time String 创建时间 update_time String 最后一次修改时间 app_type String 应用类型 function_type String 功能类型 container_settings ModuleContainerSettingsResDTO object 容器相关配置 表4 ModuleContainerSettingsResDTO 参数 参数类型 描述 configs ContainerConfigsResDTO object 容器相关配置 custom_envs Object 自定义环境变量 extra_hosts Array of DNSConfigDTO objects 域名 解析配置集合 表5 ContainerConfigsResDTO 参数 参数类型 描述 host_network Boolean 是否使用主机网络模式 container_port_list Array of ContainerPortDTO objects 容器端口映射值 表6 ContainerPortDTO 参数 参数类型 描述 container_port Integer 构成一堆映射的容器端口 host_port Integer 构成一对映射的物理机对应网卡端口 host_ip String 对应网卡地址 表7 DNSConfigDTO 参数 参数类型 描述 hostname String 域名 ip String 域名解析对应IP
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-更新应用版本状态:响应参数
    响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 edge_app_id String 应用ID name String 应用名称 version String 应用名称 sdk_version String 应用集成的边缘SDK版本 description String 应用描述 deploy_type String 部署类型docker|process deploy_multi_instance Boolean 是否允许部署多实例 create_time String 创建时间 update_time String 最后一次修改时间 state String 应用版本状态 arch Array of strings 架构 publish_time String 发布时间 off_shelf_time String 下线时间
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-更新应用版本状态:URI
    URI PUT /v2/{project_id}/edge-apps/{edge_app_id}/versions/{version}/state 表1 路径参数 参数 是否必选 参数类型 描述 edge_app_id 是 String 应用ID，应用唯一标识。 version 是 String 应用版本,应用内版本唯一。 project_id 是 String 项目ID。获取方法请参见 获取项目ID。
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-更新应用版本状态:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 state 否 String 应用版本状态
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-更新应用版本状态:响应示例
    响应示例 状态码：200 OK { "edge_app_id" : "test-app", "name" : "string", "version" : "1.0.0", "sdk_version" : "string", "description" : "this is a test app", "deploy_type" : "string", "deploy_multi_instance" : false, "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z", "state" : "PUBLISHED", "arch" : [ "string" ], "publish_time" : "2020-05-28T11:31:29.740Z", "off_shelf_time" : "2020-05-28T11:31:29.740Z" }
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-设置边缘路由:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of CreateRouterReqDTO objects 创建路由请求结构体 表4 CreateRouterReqDTO 参数 是否必选 参数类型 描述 route_id 是 String 路由ID，节点下唯一 sql 是 String sql參數
    IOT边缘 IOTEDGE 数据流转配置管理
  • IOT边缘 IOTEDGE-查询数采模板详情:响应示例
    响应示例 状态码：200 修改数据库配置数据 { "tpl_id" : "string", "name" : "string", "description" : "string", "datasource_meta" : { }, "point_meta" : { }, "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z" }
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-查询数采模板详情:响应参数
    响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 tpl_id String 模板id name String 模板名称 description String 描述 datasource_meta Object 数据源元数据 point_meta Object 点位表元数据 create_time String 创建时间 update_time String 最后一次修改时间
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-创建数据源配置:请求示例
    请求示例 POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources { "ds_id" : "opcua_1", "config" : { "connection_info" : { "endpoint" : "opc.tcp://127.0.0.1:53530/OPCUA", "username" : "admin", "password" : "*****" }, "collection_paras" : { "default_cycle" : 1000 } }, "name" : "电力子系统", "module_id" : "user_opc_ua_yz", "tpl_id" : "sys_general_opcua", "quality_report" : false }
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-创建数据源配置:响应示例
    响应示例 状态码：201 Created { "ds_id" : "opcua_1", "config" : { "connection_info" : { "endpoint" : "opc.tcp://127.0.0.1:53530/OPCUA", "username" : "admin", "password" : "*****" }, "collection_paras" : { "default_cycle" : 1000 } }, "name" : "电力子系统", "edge_node_id" : "446007715895193600", "module_id" : "user_opc_ua_yz", "tpl_id" : "sys_general_opcua", "quality_report" : false, "edge_app_name" : "西门子OPCUA驱动", "connection_info" : { }, "module_state" : "stopped", "count" : 1000000, "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z", "synchronized" : true, "synchronized_time" : "2020-05-28T11:31:29.740Z" }
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-创建数据源配置:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 ds_id 是 String 采集数据源id，节点下唯一 config 是 Object 数据源的连接及采集信息 name 是 String 采集数据源名称，允许中、数字、英文大小写、下划线、中划线 module_id 是 String 模块id tpl_id 是 String 模板id，节点下唯一 quality_report 否 Boolean 质量上报开关，不携带或值不为true，默认为false
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-创建数据源配置:响应参数
    响应参数 状态码：201 表4 响应Body参数 参数 参数类型 描述 ds_id String 采集数据源id，节点下唯一 config Object 数据源的连接及采集信息 name String 采集数据源名称，允许中、数字、英文大小写、下划线、中划线 edge_node_id String 边缘节点id module_id String 模块id tpl_id String 模板id，节点下唯一 quality_report Boolean 质量上报开关，不携带或值不为true，默认为false edge_app_name String 应用ID connection_info Object 数采连接信息 module_state String 数采连接状态,stopped|running count Long 数采连接下点位数 create_time String 创建时间 update_time String 最后一次修改时间 synchronized Boolean 数采配置是否已同步，已同步：true,未同步：false synchronized_time String 数采配置同步时间
    IOT边缘 IOTEDGE
  • IOT边缘 IOTEDGE-下发数采配置:URI
    URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/synchronize 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。
    IOT边缘 IOTEDGE
共100000条
undefined

搜索反馈

您找到想要的内容了吗?

是的 没有

意见反馈

0/200

提交 取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好 反馈提交失败！请稍后重试！
推荐文章
提示

您即将访问非华为云网站，请注意账号财产安全

取消 继续访问