华为云用户手册

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表4 请求Body参数 参数 是否必选 参数类型 描述 host_tag 否 String 安装命令执行的主机标签DEFAULT|MASTER|SLAVE

URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/install 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 表2 Query参数 参数 是否必选 参数类型 描述 arch 是 String 节点架构 enable_tpm 否 Boolean 是否启用TPM

URI POST /v2/{project_id}/edge-nodes/{node_id}/ias/{ia_id}/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 node_id 是 String 边缘节点ID ia_id 是 String 边侧第三方应用的模块ID 表2 Query参数 参数 是否必选 参数类型 描述 action 是 String confirm

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表4 请求Body参数 参数 是否必选 参数类型 描述 configs 否 Array of ConfirmIaConfigRequestBody objects 确认配置项列表 表5 ConfirmIaConfigRequestBody 参数 是否必选 参数类型 描述 id 是 String 配置项ID version 是 String 版本号

响应示例 状态码：200 OK { "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" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 edge_app_id String 应用id description String 应用描述 create_time String 创建时间 update_time String 最后一次修改时间 last_published_version String 最新发布版本 app_type String 应用类型SYSTEM_REQUIRED|SYSTEM_OPTIONAL|USER function_type String 应用类型DATA_PRO CES SING|PROTOCOL_PARSING deploy_type String 部署类型docker|process protocol String 驱动协议类型OPCUA|Modbus-TCP edge_app_name String 应用名称 delivered_app Boolean 是否是下发到端侧网关上应用。

请求示例 { "edge_node_id" : "string", "name" : "test-node", "type" : "string", "verify_code" : "string", "time_out" : 1800, "arch" : "string", "instance_id" : "string", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "resource_ids" : [ "jeQDJQZltU8iKgFFoW060F5SGZka" ], "security_level" : "HIGH", "reliability_level" : "LOW", "storage_period" : 0, "ai_card_type" : "UNEQUIPPED", "npu_library_path" : "/usr/local/Ascend/driver/lib64/", "base_path" : { "log_base_path" : "string", "config_base_path" : "string", "db_base_path" : "string" }, "log_configs" : [ { "size" : 1000, "level" : "string", "rotate_num" : 10, "rotate_period" : "string", "type" : "LTS", "component" : "string" } ], "apps" : [ { "edge_app_id" : "string", "app_version" : "string" } ], "hardware_model" : "string", "offline_cache_configs" : { "publish_order" : "realtime_first", "period" : 7, "capacity" : 2048 }, "device_auth_info" : { "auth_type" : "CERTIFICATES", "fingerprint" : "8D903AC66E0ECA7843B6EEFB50F770537C051EC3C976FD3ED3AFBECC1CC92A29", "local_path" : { "cert_path" : "/opt/device-cert/cert.pem", "key_path" : "/opt/device-cert/key.pem" } }, "automatic_upgrade" : "OFF" }

响应示例 状态码：201 Created { "edge_node_id" : "string", "name" : "string", "instance_id" : "string", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "product_id" : "string", "product_name" : "jeQDJQZltU8iKgFFoW060F5SGZka", "state" : "string", "type" : "string", "installer_version" : "string", "base_path" : { "log_base_path" : "string", "config_base_path" : "string", "db_base_path" : "string" }, "resource_ids" : [ "jeQDJQZltU8iKgFFoW060F5SGZka" ], "ips" : [ "string" ], "create_time" : "2020-05-28T11:31:29.740Z", "hardware_model" : "string", "device_data_format" : "iotda_1.0", "automatic_upgrade" : "OFF", "os_type" : "generalLinux" }

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

URI DELETE /v2/{project_id}/edge-nodes/{edge_node_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 表2 Query参数 参数 是否必选 参数类型 描述 delete_external_node 否 Boolean 是否同时删除外部节点（仅对专业版有效），默认为false不删除IEF侧的边缘节点

请求示例 PUT https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/schedules/{schedule_id} { "name" : "H1照明控制", "enabled" : true, "start_time" : 1691572410000, "end_time" : 1691572410000, "priority" : 9, "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 } } ] } ] }

响应示例 状态码：200 OK { "schedule_id" : "1A", "node_id" : "node1", "name" : "H1照明控制", "cycle_type" : "daily", "enabled" : true, "reset_current_task" : false, "start_time" : 1691572410000, "end_time" : 1691572410000, "priority" : 9, "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 } } ] } ] }

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 configs Array of QueryIaConfigResponseDTO objects 南向3rdIA配置项列表 表5 QueryIaConfigResponseDTO 参数 参数类型 描述 id String 配置ID name String 配置项名称 value String 配置项详情 description String 配置项描述 version Long 版本号 state String 下发状态 create_time String 创建时间 update_time String 更新时间

响应示例 状态码：200 OK { "configs" : [ { "id" : "config1", "name" : "配置项1", "value" : "配置项详情1", "description" : "这是一个配置项", "version" : 1603694409089, "state" : "SUCCESS", "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z" } ] }

URI GET /v2/{project_id}/edge-nodes/{node_id}/ias/{ia_id}/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 node_id 是 String 边缘节点ID ia_id 是 String 边侧第三方应用的模块ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页记录数，取值范围为非负整数，默认值为10

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

响应参数 状态码：200 表3 响应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 数采配置同步时间

响应示例 状态码：200 Ok { "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" }

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 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。 point_id 是 String 采集点位表id，创建点位表时设置，数据源下唯一。 表2 Query参数 参数 是否必选 参数类型 描述 device_id 否 String 设备id property 否 String 设备服务属性，允许中、数字、英文大小写、下划线、中划线

响应示例 状态码：200 OK { "tpl_id" : "sys_general_opcua", "name" : "sys_general_opcua", "description" : "通用opcua模板", "datasource_meta" : { "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" : { "drivername" : "OPCUA" } }, "point_meta" : { "config_items" : [ { "key" : "address", "name" : "点位地址", "description" : "采集点位的地址", "example" : "ns=2;s=Root/Motor/Voltage" }, { "key" : "data_type", "name" : "点位值的数据类型", "description" : "点位地址存储值的数据类型" }, { "key" : "cycle", "name" : "点位采集周期", "description" : "点位采集周期" } ] } }

请求示例 GET https://{endpoint}/v2/{project_id}/templates/ots/data-sources { "tpl_id" : "sys_general_opcua", "name" : "sys_general_opcua", "description" : "通用opcua模板", "datasource_meta" : { "config_tabs" : [ { "key" : "connection_info", "name" : "连接信息", "description" : "连接信息", "config_items" : [ { "key" : "endpoint", "name" : "服务端点", "description" : "服务完整URL", "data_type" : "string", "required" : true, "crypted" : false, "max_length" : 128, "example" : "opc.tcp://127.0.0.1:53530/OPCUA" }, { "key" : "username", "name" : "用户名", "description" : "OPCUA服务器认证用户名", "data_type" : "string", "required" : false, "crypted" : false, "max_length" : 128, "example" : "admin" }, { "key" : "password", "name" : "密码", "description" : "OPCUA服务器认证密码", "data_type" : "string", "required" : false, "crypted" : true, "max_length" : 512, "example" : "******" } ] }, { "key" : "collection_paras", "name" : "连接附加参数", "description" : "连接附加参数", "config_items" : [ { "key" : "default_cycle", "name" : "采集周期", "description" : "采集周期", "data_type" : "int", "required" : true, "crypted" : false, "max_length" : 65535, "example" : 10000 } ] } ], "default_values" : { "drivername" : "OPCUA" } }, "point_meta" : { "config_items" : [ { "key" : "address", "name" : "点位地址", "description" : "采集点位的地址", "data_type" : "string", "required" : true, "crypted" : false, "max_length" : 256, "example" : "ns=2;s=Root/Motor/Voltage" }, { "key" : "data_type", "name" : "点位值的数据类型", "description" : "点位地址存储值的数据类型", "data_type" : "string", "required" : true, "crypted" : false, "max_length" : 128, "example" : "int，decimal" }, { "key" : "cycle", "name" : "点位采集周期", "description" : "点位采集周期", "data_type" : "int", "required" : true, "crypted" : false, "max_length" : 65535, "example" : 10000 } ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 tpl_id 是 String 模板id name 是 String 模板名称，允许中、数字、英文大小写、下划线、中划线 description 是 String 描述 datasource_meta 是 Object 数据源元数据 point_meta 是 Object 点位表元数据

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 tpl_id String 模板id name String 模板名称 description String 描述 datasource_meta Object 数据源元数据 point_meta Object 点位表元数据 create_time String 创建时间 update_time String 最后一次修改时间

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 properties 否 Object 应用配置内容

请求示例 PUT https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}/shadow: { "properties" : { "connect_info" : { "endpoint" : "string", "user_name" : "string", "password" : "string" }, "channels" : [ { "device_id" : "string", "peer_session_name" : "string", "pin_code" : "string", "role_type" : "string" } ] } }

响应示例 状态码：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 } }

响应示例 状态码：200 OK { "nas" : [ { "na_id" : "na_id_1", "name" : "北向NA系统1", "description" : "这是一个北向NA", "endpoint" : "https://068b72f3b75444dda67cc6e2286a4c20.apic.cn-south-1.huaweicloudapis.com", "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z" } ] }

URI GET /v2/{project_id}/nas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String NA名称搜索关键字 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页记录数，取值范围为非负整数，默认值为10

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 nas Array of QueryNaBriefResponseDTO objects 北向NA列表 表5 QueryNaBriefResponseDTO 参数 参数类型 描述 na_id String NA系统ID，提供给其他系统访问的唯一标识 name String NA系统名称 description String 北向NA系统描述 endpoint String 访问URL地址 create_time String 创建时间 update_time String 更新时间