华为云用户手册

响应示例 状态码：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认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 ProxyPayload 是 Object 代理消息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 external_id 是 String 外部实体Id，节点下唯一 protocol 是 String 连接外部实体的协议类型 connection_type 是 String 连接类型 mqtt_connection_info 否 MqttConnectionInfo object mqtt连接信息 space_id 否 String 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下，否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id. 表4 MqttConnectionInfo 参数 是否必选 参数类型 描述 server_address 否 String 采用cleint方式连接时，mqtt服务器地址 client_id 否 String mqtt连接时，client_id auth_type 否 String 鉴权类型。支持密钥认证接入(SECRET)和证书认证接入(CERTIFICATES)两种方式。使用密钥认证接入方式(SECRET)填写user_name和user_name字段，使用证书认证接入方式(CERTIFICATES)填写privateKey和certificate字段 private_key 否 String 证书密钥 certificate 否 String 证书 user_name 否 String 用户名 password 否 String 密码 qos 否 Integer 服务质量,默认为0,表示最多一次的传输,1表示至少一次,2表示仅一次.

响应参数 状态码：201 表5 响应Body参数 参数 参数类型 描述 node_id String 节点ID space_id String 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下，否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id. external_id String 外部实体ID protocol String 接入协议类型：MQTT，HTTP。 connection_type String 连接类型(client和server) create_time String 创建时间 last_modify_time String 最后修改时间

请求示例 POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/externals { "external_id" : "test", "protocol" : "MQTT", "connection_type" : "CLIENT", "mqtt_connection_info" : { "server_address" : "ssl://127.0.0.1:88883", "client_id" : "client_id", "auth_type" : "SECRET", "private_key" : "MIIGsDCCBJigAwIBAgIIdrfb4YBBxtQwDQYJKoZIhvcNAQELBQAwgZIxCzAJBgNV", "certificate" : "MIIGsDCCBJigAwIBAgIIdrfb4YBBxtQwDQYJKoZIhvcNAQELBQAwgZIxCzAJBgNV", "user_name" : "user_name", "password" : "password", "qos" : 0 }, "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka" }

响应示例 状态码：201 Created { "node_id" : "string", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "external_id" : "string", "protocol" : "string", "connection_type" : "string", "create_time" : "string", "last_modify_time" : "string" }

请求示例 POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/devices/controls/default-values { "devices" : [ { "device_id" : "string", "service_id" : "string", "properties" : { "property1" : "123456", "property2" : 1111 } } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 devices 是 Array of DeviceDefaultValues objects 设备默认值数组 表4 DeviceDefaultValues 参数 是否必选 参数类型 描述 device_id 是 String 设备ID service_id 否 String 服务id，可选 properties 是 Object 属性key和value的map，用于设置属性的值

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

响应示例 状态码：200 OK { "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 PUT /v2/{project_id}/edge-nodes/{node_id}/ias/{ia_id}/configs/{config_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 node_id 是 String 边缘节点ID ia_id 是 String 边侧第三方应用的模块ID config_id 是 String 配置ID

URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/devices/{device_id}/controls/release 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID device_id 是 String 设备ID

请求参数 表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 调度计划优先级。 properties 是 Array of strings 控制释放的属性数组

响应示例 状态码：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 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 page_info PageInfoDTO object 分页信息 templates Array of QueryOtTemplateBriefRespDTO objects 每页记录数 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 limit Integer 每页记录数 表6 QueryOtTemplateBriefRespDTO 参数 参数类型 描述 tpl_id String 模板id name String 模板名称 description String 描述 create_time String 创建时间 update_time String 最后一次修改时间

响应示例 状态码：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 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。

响应示例 状态码：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 Ok 示例 1 [ { "size" : 1000, "level" : "string", "rotate_num" : 10, "rotate_period" : "string", "type" : "LTS", "component" : "string" } ] 示例 2 { "ha_type" : "ACTIVE_STANDBY", "active_standby_config" : { "work_node" : "DEFAULT", "master_interface_name" : "eth0", "slave_interface_name" : "eth0", "virtual_ip_address" : "127.0.0.1", "virtual_ipv6_address" : "ABCD:EF01:2345:6789:ABCD:EF01:2345:6789" } } 示例 3 "string" 示例 4 "string" 示例 5 "string" 示例 6 "jeQDJQZltU8iKgFFoW060F5SGZka" 示例 7 "jeQDJQZltU8iKgFFoW060F5SGZka" 示例 8 [ "iotedge.campus.1000tps.10000device" ] 示例 9 [ "jeQDJQZltU8iKgFFoW060F5SGZka" ] 示例 10 [ "string" ] 示例 11 "string" 示例 12 "string" 示例 13 "1.0.0" 示例 14 "string" 示例 15 "string" 示例 16 "string" 示例 17 "string" 示例 18 "string" 示例 19 [ { "eth" : "string", "ip" : "string", "mask_len" : 24 } ] 示例 20 "string" 示例 21 "string" 示例 22 "/usr/local/Ascend/driver/lib64/" 示例 23 "17.0.1" 示例 24 "string" 示例 25 "HIGH" 示例 26 "LOW" 示例 27 7 示例 28 { "log_base_path" : "string", "config_base_path" : "string", "db_base_path" : "string" } 示例 29 "string" 示例 30 { "publish_order" : "realtime_first", "period" : 7, "capacity" : 2048, "channel_cache_state" : "str" } 示例 31 { "auth_type" : "CERTIFICATES", "local_path" : { "cert_path" : "/opt/device-cert/cert.pem", "key_path" : "/opt/device-cert/key.pem" } } 示例 32 "string" 示例 33 "string" 示例 34 { "disk_quota" : 512, "age" : 1, "state" : "off" } 示例 35 "string" 示例 36 "100.94.18.123:8883" 示例 37 { "manufacture_id" : "string", "spec_version" : "string" } 示例 38 { "enable_tpm" : false } 示例 39 "generalLinux"

请求示例 PUT https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id} { "name" : "test-node", "storage_period" : 0, "log_configs" : [ { "size" : 1000, "level" : "string", "rotate_num" : 10, "rotate_period" : "string", "type" : "LTS", "component" : "string" } ], "ha_config" : { "ha_type" : "ACTIVE_STANDBY", "active_standby_config" : null, "work_node" : "DEFAULT", "master_interface_name" : "eth0", "slave_interface_name" : "eth0", "virtual_ip_address" : "127.0.0.1", "virtual_ipv6_address" : "ABCD:EF01:2345:6789:ABCD:EF01:2345:6789" }, "hardware_model" : "string", "npu_library_path" : "/usr/local/Ascend/driver/lib64/", "automatic_upgrade" : "OFF", "device_data_record" : { "disk_quota" : 512, "age" : 7, "state" : "off" }, "metric_report" : "on", "offline_cache_configs" : { "publish_order" : "realtime_first", "period" : 7, "capacity" : 2048 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 边缘节点名称，只允许中、数字、英文大小写、中划线、下划线 storage_period 否 Integer 节点的存储周期，默认0天，取值范围0~7天，0天则不存储。 log_configs 否 Array of LogConfigDTO objects 边缘节点在IEF日志配置参数 ha_config 否 HaConfigDTO object 高可用配置参数 hardware_model 否 String 网关型号 npu_library_path 否 String npu驱动动态库路径 automatic_upgrade 否 String 自动升级系统应用的节点开关，默认为关闭：OFF，IMMEDIATE表示节点开关打开 device_data_record 否 DeviceDataRecord object 边缘节点设备数据上报打印配置 metric_report 否 String omagent监控运维工具是否上报指标 offline_cache_configs 否 UpdateOfflineCacheConfigsDTO object 边缘节点离线缓存配置 表4 LogConfigDTO 参数 是否必选 参数类型 描述 size 否 Integer 应用日志文件大小限制，单位MB，默认50，取值范围10-1000 level 否 String 应用日志级别，可选项：on/off/trace/debug/info/warn/error/fatal，当type为LTS时有效。当选择非on/off的选项时，将只采集大于等于指定级别的日志。 rotate_num 否 Integer 应用日志rotate个数，默认5，取值范围1-10 rotate_period 否 String 应用日志rotate周期，可选项： daily/monthly/weekly/yearly type 否 String LTS:将日志发送到LTS, local 本地日志 component 否 String app:部署到边缘设备上的应用的日志, system 边缘设备上系统的日志 表5 HaConfigDTO 参数 是否必选 参数类型 描述 ha_type 否 String 节点高可用类型双活或者主备 active_standby_config 否 ActiveStandbyConfigDTO object 主备详细配置 表6 ActiveStandbyConfigDTO 参数 是否必选 参数类型 描述 work_node 否 String 当前的工作节点，主节点还是备节点在工作，初始创建时工作节点为DEFAULT节点，(DEFAULT|MASTER|SLAVE) master_interface_name 否 String 主节点网卡名称 slave_interface_name 否 String 备节点网卡名称 virtual_ip_address 否 String 网卡ip virtual_ipv6_address 否 String 网卡ipv6地址 表7 DeviceDataRecord 参数 是否必选 参数类型 描述 disk_quota 是 Integer 磁盘配额，单位MB，参考值，只能保证在这个值左右 age 是 Integer 老化时间，日志压缩文件名时间戳老于这个时间就会发生老化删除 state 是 String 配置开关，true启用数据打印，false不启用数据打印 表8 UpdateOfflineCacheConfigsDTO 参数 是否必选 参数类型 描述 capacity 否 Integer 节点离线缓存容量，单位MB，默认2048，取值范围500-65536

响应参数 状态码：200 表4 响应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 最后一次修改时间 表5 ProcessingConfigDTO 参数 参数类型 描述 validity PointValidityingDTO object 点位校验 stream_formula String 点位流公式配置字段 scaling PointScalingDTO object 点位缩放规则列表 clean PointCleanDTO object 点位计算规则列表 表6 PointValidityingDTO 参数 参数类型 描述 min Object 点位上报值的最小值，小于该值则上报告警 max Object 点位上报值的最大值，大于该值则上报告警 outlier_filtering Boolean 异常值过滤 表7 PointScalingDTO 参数 参数类型 描述 ratio Double 缩放的倍率 base Double 基准值 accuracy Integer 缩放后结果的精度，精确到小数点后几位,-1表示全部保留，0表示只保留整数位 表8 PointCleanDTO 参数 参数类型 描述 silent_window Integer 静默时间窗口，在该时间窗口内，没有触发上报条件，点位将不会上 deviation Double 偏差，在该偏差范围内表示是正常波动，点位将不进行上报

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

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 externals Array of ExternalEntityRespDTO objects 外部实体列表 表5 ExternalEntityRespDTO 参数 参数类型 描述 node_id String 节点ID space_id String 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下，否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id. external_id String 外部实体ID protocol String 接入协议类型：MQTT，HTTP。 connection_type String 连接类型(client和server) create_time String 创建时间 last_modify_time String 最后修改时间

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

响应示例 状态码：200 Ok { "externals" : [ { "node_id" : "string", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "external_id" : "string", "protocol" : "string", "connection_type" : "string", "create_time" : "string", "last_modify_time" : "string" } ] }

请求示例 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 Created { "schedule_id" : "1A", "node_id" : "node1", "name" : "H1照明控制", "cycle_type" : "daily", "enabled" : true, "reset_current_task" : false, "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 } } ] } ] }