华为云用户手册

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

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

URI GET /v2/{project_id}/edge-apps/{edge_app_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 edge_app_id 是 String 应用版本,应用内版本唯一。 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 version 否 String 应用版本搜索关键字 最小长度：0 最大长度：32 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000 最小值：0 最大值：1000000 缺省值：10 ai_card_type 否 String ai加速卡类型 最小长度：0 最大长度：64 枚举值： GPU NPU UNEQUIPPED arch 否 String 支持架构 最小长度：0 最大长度：64 枚举值： x86_64 arm32 arm64 state 否 String 应用版本状态 最小长度：0 最大长度：64 枚举值： DRAFT PUBLISHED OFF_SHELF deploy_type 否 String 应用部署类型 最小长度：0 最大长度：64 枚举值： docker process

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 versions Array of QueryEdgeAppVersionBriefResponseDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 QueryEdgeAppVersionBriefResponseDTO 参数 参数类型 描述 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

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

请求示例 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

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

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

响应参数 状态码： 200 表3 响应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 容器相关配置 表4 ModuleContainerSettingsResDTO 参数 参数类型 描述 configs ContainerConfigsResDTO object 容器相关配置 custom_envs Object 自定义环境变量 extra_hosts Array of DNSConfigDTO objects 域名解析配置集合 数组长度：0 - 20 表5 ContainerConfigsResDTO 参数 参数类型 描述 host_network Boolean 是否使用主机网络模式 缺省值：false 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

URI GET /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

响应参数 状态码： 200 表4 响应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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 state 否 String 应用版本状态 枚举值： PUBLISHED OFF_SHELF

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

URI PUT /v2/{project_id}/edge-apps/{edge_app_id}/versions/{version}/state 表1 路径参数 参数 是否必选 参数类型 描述 edge_app_id 是 String 应用ID，应用唯一标识。 最小长度：1 最大长度：32 version 是 String 应用版本,应用内版本唯一。 最小长度：1 最大长度：32 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64

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

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

请求示例 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 }

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

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 ds_id String 采集数据源id，节点下唯一 最小长度：1 最大长度：64 config Object 数据源的连接及采集信息 name String 采集数据源名称，允许中、数字、英文大小写、下划线、中划线 最小长度：1 最大长度：64 edge_node_id String 边缘节点id 最小长度：1 最大长度：64 module_id String 模块id 最小长度：1 最大长度：64 tpl_id String 模板id，节点下唯一 最小长度：1 最大长度：64 quality_report Boolean 质量上报开关，不携带或值不为true，默认为false edge_app_name String 应用ID 最小长度：0 最大长度：64 connection_info Object 数采连接信息 module_state String 数采连接状态,stopped|running 最小长度：1 最大长度：32 count Long 数采连接下点位数 最小值：0 最大值：1000000 create_time String 创建时间 最小长度：0 最大长度：256 update_time String 最后一次修改时间 最小长度：0 最大长度：256 synchronized Boolean 数采配置是否已同步，已同步：true,未同步：false synchronized_time String 数采配置同步时间 最小长度：0 最大长度：256

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 ds_id 是 String 采集数据源id，节点下唯一 最小长度：1 最大长度：64 config 是 Object 数据源的连接及采集信息 name 是 String 采集数据源名称，允许中、数字、英文大小写、下划线、中划线 最小长度：1 最大长度：64 module_id 是 String 模块id 最小长度：1 最大长度：64 tpl_id 是 String 模板id，节点下唯一 最小长度：1 最大长度：64 quality_report 否 Boolean 质量上报开关，不携带或值不为true，默认为false 缺省值：false

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 最小长度：1 最大长度：64 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。 最小长度：1 最大长度：64

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

响应示例 状态码： 200 Ok { "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" : { "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" } }, "edge_node_id" : "string", "instance_id" : "string", "product_id" : "string", "product_name" : "jeQDJQZltU8iKgFFoW060F5SGZka", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "resource_spec_types" : [ "iotedge.campus.1000tps.10000device" ], "resource_ids" : [ "jeQDJQZltU8iKgFFoW060F5SGZka" ], "ips" : [ "string" ], "name" : "string", "state" : "string", "software_version" : "1.0.0", "create_time" : "string", "update_time" : "string", "os_name" : "string", "arch" : "string", "host_name" : "string", "nics" : [ { "eth" : "string", "ip" : "string", "mask_len" : 24 } ], "specification" : "string", "ai_card_type" : "string", "npu_library_path" : "/usr/local/Ascend/driver/lib64/", "container_version" : "17.0.1", "type" : "string", "security_level" : "HIGH", "reliability_level" : "LOW", "storage_period" : 7, "base_path" : [ { "log_base_path" : "string", "config_base_path" : "string", "db_base_path" : "string" } ], "hardware_model" : "string", "offline_cache_configs" : { "publish_order" : "realtime_first", "period" : 7, "capacity" : 2048 }, "device_auth_info" : { "auth_type" : "CERTIFICATES", "local_path" : { "cert_path" : "/opt/device-cert/cert.pem", "key_path" : "/opt/device-cert/key.pem" } }, "device_data_format" : "iotda_1.0", "automatic_upgrade" : "OFF" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 log_configs Array of LogConfigDTO objects 边缘节点在IEF的日志配置 数组长度：0 - 10 ha_config HaConfigDTO object 节点根目录配置 edge_node_id String 边缘节点Id 最小长度：1 最大长度：64 instance_id String 实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。 最小长度：1 最大长度：36 product_id String 边缘节点关联的产品ID，用于唯一标识一个产品模型。 最小长度：1 最大长度：36 product_name String 边缘节点关联的产品名称。 最小长度：1 最大长度：64 space_id String 资源空间id，对应IOTDA云服务接口参数中的app_id。 最小长度：1 最大长度：64 resource_spec_types Array of strings 节点所购买的资源类型的列表 最小长度：4 最大长度：16 resource_ids Array of strings 资源id列表，创建节点时需绑定已购买的资源包，可以叠加节点功能。 最小长度：1 最大长度：64 ips Array of strings 边缘节点主机ip 数组长度：0 - 10 name String 边缘节点名称 最小长度：1 最大长度：64 state String 边缘节点状态 最小长度：4 最大长度：32 software_version String 边缘应用id，只允许数字、英文小写、中划线，切必须以字母或数字结尾 最小长度：0 最大长度：32 create_time String 边缘节点创建时间 最小长度：0 最大长度：256 update_time String 边缘节点更新时间 最小长度：0 最大长度：256 os_name String 边缘节点操作系统名称 最小长度：1 最大长度：64 arch String 边缘节点操作系统架构 最小长度：4 最大长度：16 host_name String 边缘节点主机名 最小长度：1 最大长度：256 nics Array of Nic objects 边缘节点网络网卡信息 数组长度：0 - 10 specification String 网络规格，如4 cores | 3867 MB 最小长度：0 最大长度：64 ai_card_type String AI加速卡类型，如华为昇腾AI加速卡NPU、图像处理加速卡GPU。 最小长度：0 最大长度：16 npu_library_path String npu驱动动态库路径 最小长度：0 最大长度：256 container_version String 容器运行时版本 最小长度：0 最大长度：64 type String 节点所属资源类型：advanced|standard 最小长度：4 最大长度：16 security_level String 节点的安全等级，MEDIUM边缘节数据上报不进行加密，HIGH对数据上报进行加密。 最小长度：1 最大长度：64 reliability_level String 节点的可靠性等级。 缺省值：LOW 最小长度：1 最大长度：64 storage_period Integer 节点的存储周期，默认0天，取值范围0~7天，0天则不存储。 最小值：0 最大值：7 base_path BasePathDTO object 节点根目录配置 hardware_model String 注册节点网关配置 最小长度：0 最大长度：1024 offline_cache_configs OfflineCacheConfigsDTO object 边缘节点离线缓存配置 device_auth_info DeviceAuthInfoDisplayDTO object 边缘节点设备认证方式 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 表4 LogConfigDTO 参数 参数类型 描述 size Integer 应用日志文件大小限制，单位MB，默认50，取值范围10-1000 最小值：10 最大值：1000 level String 应用日志级别，可选项：on/off/trace/debug/info/warn/error/fatal，当type为LTS时有效。当选择非on/off的选项时，将只采集大于等于指定级别的日志。 rotate_num Integer 应用日志rotate个数，默认5，取值范围1-10 最小值：1 最大值：10 rotate_period String 应用日志rotate周期，可选项： daily/monthly/weekly/yearly type String LTS:将日志发送到LTS, local 本地日志 缺省值：LTS component String app:部署到边缘设备上的应用的日志, system 边缘设备上系统的日志 表5 HaConfigDTO 参数 参数类型 描述 ha_type String 节点高可用类型双活或者主备 缺省值：ACTIVE_STANDBY active_standby_config ActiveStandbyConfigDTO object 主备详细配置 表6 ActiveStandbyConfigDTO 参数 参数类型 描述 work_node String 当前的工作节点，主节点还是备节点在工作，初始创建时工作节点为DEFAULT节点，(DEFAULT|MASTER|SLAVE) 缺省值：DEFAULT 最小长度：1 最大长度：64 master_interface_name String 主节点网卡名称 最小长度：1 最大长度：64 slave_interface_name String 备节点网卡名称 最小长度：1 最大长度：64 virtual_ip_address String 网卡ip 最小长度：0 最大长度：64 virtual_ipv6_address String 网卡ipv6地址 最小长度：0 最大长度：64 表7 Nic 参数 参数类型 描述 eth String 网卡信息，如eth0,eth1 最小长度：0 最大长度：32 ip String 网卡ip 最小长度：0 最大长度：64 mask_len Integer 子网掩码的位数 最小值：0 最大值：32 表8 BasePathDTO 参数 参数类型 描述 log_base_path String 节点日志根目录 最小长度：1 最大长度：64 config_base_path String 节点配置根目录 最小长度：1 最大长度：64 db_base_path String 节点数据存储根目录 最小长度：1 最大长度：64 表9 OfflineCacheConfigsDTO 参数 参数类型 描述 publish_order String 数据上报优先级，可选项：realtime_first实时数据优先 sequential按时序上报，默认realtime_first 缺省值：realtime_first period Integer 节点离线缓存数据的储存天数，默认7，取值范围-1~14，-1表示存储天数没有限制 最小值：-1 最大值：14 缺省值：7 capacity Integer 节点离线缓存容量，单位MB，默认2048，取值范围500-8192 最小值：500 最大值：8192 缺省值：2048 表10 DeviceAuthInfoDisplayDTO 参数 参数类型 描述 auth_type String 边缘节点认证方式。 缺省值：SECRET local_path CertificateLocalPathDTO object 证书文件的本地存储路径 表11 CertificateLocalPathDTO 参数 参数类型 描述 cert_path String 节点数字证书的本地存储路径。 最小长度：1 最大长度：2048 key_path String 证书私钥的本地存储路径。 最小长度：1 最大长度：2048 表12 DeviceDataRecord 参数 参数类型 描述 disk_quota Integer 磁盘配额，单位MB，参考值，只能保证在这个值左右 最小值：512 最大值：10240 缺省值：512 age Integer 老化时间，日志压缩文件名时间戳老于这个时间就会发生老化删除 最小值：1 最大值：7 缺省值：1 state String 配置开关，true启用数据打印，false不启用数据打印 最小长度：0 最大长度：16

响应示例 状态码： 200 OK { "devices" : [ { "device_id" : "string", "node_id" : "string", "gateway_id" : "string", "device_name" : "string", "protocol_type" : "string", "product_name" : "string", "product_id" : "string" } ], "count" : "0,", "page_info" : { "offset" : 1000000, "limit" : 1000 } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 devices Array of QueryDeviceSimplifyDto objects 查询设备列表响应结构体 数组长度：0 - 1000000 count Long 满足查询条件的记录总数。 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 表5 QueryDeviceSimplifyDto 参数 参数类型 描述 device_id String 设备id 最小长度：0 最大长度：256 node_id String 设备识别码 最小长度：0 最大长度：64 gateway_id String 父设备id 最小长度：0 最大长度：256 device_name String 设备名称 最小长度：0 最大长度：256 protocol_type String 设备协议类型 最小长度：0 最大长度：20 product_name String 产品名称 最小长度：0 最大长度：255 product_id String 产品ID 最小长度：0 最大长度：255 表6 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000

URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 gateway_id 否 String 父设备ID,对应之前的gatewayId的概念，传该参数时代表查询网关下的子设备，不传代表节点下的 最小长度：0 最大长度：256 device_name 否 String 设备名称 最小长度：0 最大长度：256 module_id 否 String 设备所属的模块id 最小长度：1 最大长度：64 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000 最小值：1 最大值：1000 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 devices Array of QueryDcDeviceRespDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 QueryDcDeviceRespDTO 参数 参数类型 描述 device_id String 设备id