华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 external_id 是 String 外部实体Id,节点下唯一 最小长度:1 最大长度:64 protocol 是 String 连接外部实体的协议类型 connection_type 是 String 连接类型 mqtt_connection_info 否 MqttConnectionInfo object mqtt连接信息 space_id 否 String 资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下,否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id. 最小长度:1 最大长度:36 表4 MqttConnectionInfo 参数 是否必选 参数类型 描述 server_address 否 String 采用cleint方式连接时,mqtt服务器地址 最小长度:4 最大长度:128 client_id 否 String mqtt连接时,client_id 最小长度:4 最大长度:256 auth_type 否 String 鉴权类型。支持密钥认证接入(SECRET)和证书认证接入(CERTIFICATES)两种方式。使用密钥认证接入方式(SECRET)填写user_name和user_name字段,使用证书认证接入方式(CERTIFICATES)填写privateKey和certificate字段 private_key 否 String 证书密钥 最小长度:4 最大长度:20000 certificate 否 String 证书 最小长度:4 最大长度:20000 user_name 否 String 用户名 最小长度:4 最大长度:256 password 否 String 密码 最小长度:4 最大长度:256 qos 否 Integer 服务质量,默认为0,表示最多一次的传输,1表示至少一次,2表示仅一次. 缺省值:0 最小长度:1 最大长度:1
  • 响应示例 状态码: 200 OK { "nodes" : [ { "name" : "string", "internal_ip" : "string", "hostname" : "string", "allocatable" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "capacity" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "allocated_resources" : { "request" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "limit" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 } }, "status" : "string", "architecture" : "string", "labels" : { }, "node_type" : "string", "kernel_version" : "string", "os_image" : "string", "container_runtime_version" : "string", "kubernetes_version" : "string", "create_time" : "string" } ] }
  • URI PUT /v2/{project_id}/edge-nodes/{node_id}/ias/{ia_id}/configs/{config_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 ia_id 是 String 边侧第三方应用的模块ID 最小长度:1 最大长度:64 config_id 是 String 配置ID 最小长度:1 最大长度:32
  • 响应示例 状态码: 200 OK { "id" : "config1", "name" : "配置项1", "value" : "配置项详情1", "description" : "这是一个配置项", "version" : 1603694409089, "state" : "SUC CES S", "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 配置项名称 最小长度:1 最大长度:64 value 是 String 配置项详情,长度2MB以内 最小长度:1 最大长度:2097152 description 否 String 配置项描述 最小长度:0 最大长度:255
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 配置ID 最小长度:1 最大长度:32 name String 配置项名称 最小长度:1 最大长度:64 value String 配置项详情 最小长度:1 最大长度:2048 description String 配置项描述 最小长度:0 最大长度:255 version Long 版本号 最小长度:0 最大长度:64 state String 下发状态 枚举值: SUCCESS SENDING create_time String 创建时间 最小长度:0 最大长度:256 update_time String 更新时间 最小长度:0 最大长度:256
  • URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/devices/{device_id}/controls/release 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 device_id 是 String 设备ID 最小长度:1 最大长度:128
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 control_id 是 String 控制id 最小长度:1 最大长度:128 service_id 否 String 服务id,可选 priority 是 Integer 调度计划优先级。 最小值:1 最大值:16 properties 是 Array of strings 控制释放的属性数组 数组长度:1 - 100
  • URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}/shadow 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 module_id 是 String 边缘模块ID 最小长度:1 最大长度:64
  • 响应示例 状态码: 200 模块影子详细信息 { "properties" : { "connect_info" : { "endpoint" : "string", "user_name" : "string", "password" : "string" }, "channels" : [ { "device_id" : "string", "peer_session_name" : "string", "pin_code" : "string", "role_type" : "string" } ] }, "properties_update_time" : { "connection_info" : 1676883583449, "channels" : 1676883583449, "default_values" : 1676883583449 } }
  • URI GET /v2/{project_id}/templates/ots/data-sources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:1000000 缺省值:0 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000 最小值:0 最大值:1000000 缺省值:10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 templates Array of QueryOtTemplateBriefRespDTO objects 每页记录数 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryOtTemplateBriefRespDTO 参数 参数类型 描述 tpl_id String 模板id 最小长度:1 最大长度:64 name String 模板名称 最小长度:1 最大长度:64 description String 描述 最小长度:0 最大长度:128 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256
  • 响应示例 状态码: 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "templates" : [ { "tpl_id" : "string", "name" : "string", "description" : "string", "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z" } ] }
  • URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/download-template 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 ds_id 是 String 采集数据源id,创建数据源配置时设置,节点下唯一。 最小长度:1 最大长度:64
  • 响应示例 状态码: 200 应用配置模板数据 { "tpl_id" : "general_app_tpl", "name" : "general_app_tpl", "description" : "通用应用模板", "config_tabs" : [ { "key" : "connection_info", "name" : "连接信息", "description" : "连接信息", "config_items" : [ { "key" : "endpoint", "name" : "服务端点", "description" : "服务完整URL", "example" : "opc.tcp://127.0.0.1:53530/OPCUA" }, { "key" : "username", "name" : "用户名", "description" : "OPCUA服务器认证用户名", "example" : "admin" }, { "key" : "password", "name" : "密码", "description" : "OPCUA服务器认证密码", "data_type" : "string" } ] }, { "key" : "collection_paras", "name" : "连接附加参数", "description" : "连接附加参数", "config_items" : [ { "key" : "default_cycle", "name" : "采集周期", "description" : "采集周期" } ] } ], "default_values" : { "appname" : "LINK" } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tpl_id String 模板id 最小长度:1 最大长度:64 name String 模板名称 最小长度:1 最大长度:64 description String 描述 最小长度:0 最大长度:128 config_tabs Object 配置项数据 default_values Object 默认数据 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256
  • 响应示例 状态码: 200 OK { "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" }
  • 响应参数 状态码: 200 表4 响应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 表5 ProcessingConfigDTO 参数 参数类型 描述 validity PointValidityingDTO object 点位校验 stream_formula String 点位流公式配置字段 最小长度:0 最大长度:128 scaling PointScalingDTO object 点位缩放规则列表 clean PointCleanDTO object 点位计算规则列表 表6 PointValidityingDTO 参数 参数类型 描述 min Object 点位上报值的最小值,小于该值则上报告警 max Object 点位上报值的最大值,大于该值则上报告警 outlier_filtering Boolean 异常值过滤 表7 PointScalingDTO 参数 参数类型 描述 ratio Double 缩放的倍率 最小值:-10000 最大值:10000 base Double 基准值 最小值:-10000 最大值:10000 accuracy Integer 缩放后结果的精度,精确到小数点后几位,-1表示全部保留,0表示只保留整数位 最小值:-1 最大值:8 缺省值:-1 表8 PointCleanDTO 参数 参数类型 描述 silent_window Integer 静默时间窗口,在该时间窗口内,没有触发上报条件,点位将不会上 最小值:0 最大值:86400 deviation Double 偏差,在该偏差范围内表示是正常波动,点位将不进行上报 最小值:0 最大值:100
  • URI GET /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 设备服务属性,允许中、数字、英文大小写、下划线、中划线 最小长度:0 最大长度:128
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 externals Array of ExternalEntityRespDTO objects 外部实体列表 数组长度:0 - 10 表5 ExternalEntityRespDTO 参数 参数类型 描述 node_id String 节点ID 最小长度:1 最大长度:64 space_id String 资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下,否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id. 最小长度:1 最大长度:36 external_id String 外部实体ID 最小长度:1 最大长度:64 protocol String 接入协议类型:MQTT,HTTP。 connection_type String 连接类型(client和server) create_time String 创建时间 最小长度:0 最大长度:256 last_modify_time String 最后修改时间 最小长度:0 最大长度:256
  • 响应示例 状态码: 200 Ok { "externals" : [ { "node_id" : "string", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "external_id" : "string", "protocol" : "string", "connection_type" : "string", "create_time" : "string", "last_modify_time" : "string" } ] }
  • URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/externals 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:0 缺省值:0 limit 否 Integer 每页记录数,取值范围为非负整数,默认值为10 最小值:10 最大值:10 缺省值:10
  • 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
  • 响应示例 状态码: 201 Created { "schedule_id" : "1A", "node_id" : "node1", "name" : "H1照明控制", "cycle_type" : "daily", "enabled" : true, "start_time" : 1691572410000, "end_time" : 1691572410000, "priority" : 8, "daily" : { "exceptional_dates" : { "valid_dates" : [ "2023-01-01" ], "invalid_dates" : [ "2023-01-02" ] }, "time_spans" : [ { "start" : "11:40:00", "end" : "11:49:00" } ], "weekdays" : [ 1, 2, 3 ] }, "tasks" : [ { "device_ids" : [ "device1" ], "action" : "SetProperties", "paras" : [ { "service_id" : "dataService", "properties" : { "Switch" : 1 } } ] } ] }
  • 请求示例 POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/schedules { "schedule_id" : "1A", "name" : "H1照明控制", "cycle_type" : "daily", "enabled" : true, "start_time" : 1691572410000, "end_time" : 1691572410000, "priority" : 8, "daily" : { "exceptional_dates" : { "valid_dates" : [ "2023-01-01" ], "invalid_dates" : [ "2023-01-02" ] }, "time_spans" : [ { "start" : "11:40:00", "end" : "11:49:00" } ], "weekdays" : [ 1, 2, 3 ] }, "tasks" : [ { "device_ids" : [ "device1" ], "action" : "SetProperties", "paras" : [ { "service_id" : "dataService", "properties" : { "Switch" : 1 } } ] } ] }
  • 响应参数 状态码: 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
  • 响应参数 状态码: 200 表14 响应Body参数 参数 参数类型 描述 edge_app_id String 应用ID 最小长度:0 最大长度:32 name String 应用名称 最小长度:0 最大长度:64 version String 应用名称 最小长度:0 最大长度:32 sdk_version String 应用集成的边缘SDK版本 最小长度:1 最大长度:32 description String 应用描述 最小长度:0 最大长度:256 deploy_type String 部署类型docker|process 最小长度:0 最大长度:64 deploy_multi_instance Boolean 是否允许部署多实例 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 state String 应用版本状态 枚举值: DRAFT PUBLISHED OFF_SHELF arch Array of strings 架构 数组长度:1 - 1000000 publish_time String 发布时间 最小长度:0 最大长度:256 off_shelf_time String 下线时间 最小长度:0 最大长度:256
  • 响应示例 状态码: 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" }
共100000条