华为云用户手册

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 } } }

请求参数 表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

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

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

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 表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

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

响应参数 状态码： 201 表5 响应Body参数 参数 参数类型 描述 routes Array of RouterRespDTO objects 路由列表 数组长度：0 - 1000 update_time String 最后一次修改时间 最小长度：0 最大长度：256 表6 RouterRespDTO 参数 参数类型 描述 route_id String 路由ID，节点下唯一 最小长度：1 最大长度：96 sql String sql參數 最小长度：1 最大长度：64

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of CreateRouterReqDTO objects 创建边缘模块请求的结构体 表4 CreateRouterReqDTO 参数 是否必选 参数类型 描述 route_id 是 String 路由ID，节点下唯一 最小长度：1 最大长度：96 sql 是 String sql參數 最小长度：1 最大长度：1024

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String NA系统名称 最小长度：1 最大长度：64 description 否 String 北向NA系统描述 最小长度：0 最大长度：255 endpoint 是 String 访问URL地址 最小长度：1 最大长度：512 auth_type 否 String 鉴权方式 最小长度：1 最大长度：32 auth_aksk_info 否 AuthAkSkInfo object AK/SK鉴权信息结构体 access_type 是 String 接入类型 最小长度：1 最大长度：32 access_roma_info 否 AccessRomaInfo object 接入方式为ROMA的鉴权信息结构体 表4 AuthAkSkInfo 参数 是否必选 参数类型 描述 secret 否 String 鉴权密钥 最小长度：1 最大长度：256 表5 AccessRomaInfo 参数 是否必选 参数类型 描述 app_key 否 String 认证key，加密存储 最小长度：1 最大长度：256 app_secret 否 String 认证secret，加密存储 最小长度：1 最大长度：256

请求示例 PUT https://{endpoint}/v2/{project_id}/nas/{na_id} { "name" : "string", "description" : "string", "endpoint" : "string", "auth_type" : "string", "auth_aksk_info" : { "secret" : "string" }, "access_type" : "string", "access_roma_info" : { "app_key" : "string" } }

响应示例 状态码： 200 OK { "na_id" : "na_id_1", "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" }, "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z" }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 na_id String NA系统ID，提供给其他系统访问的唯一标识 最小长度：1 最大长度：32 name String NA系统名称 最小长度：1 最大长度：64 description String 北向NA系统描述 最小长度：0 最大长度：255 endpoint String 访问URL地址 最小长度：1 最大长度：512 auth_type String 鉴权方式 最小长度：1 最大长度：32 access_type String 接入类型 最小长度：1 最大长度：32 access_roma_info AccessRomaBriefInfo object ROMA接入鉴权信息 create_time String 创建时间 最小长度：0 最大长度：256 update_time String 更新时间 最小长度：0 最大长度：256 表7 AccessRomaBriefInfo 参数 参数类型 描述 app_key String 认证key，加密存储 最小长度：1 最大长度：256

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

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 device_id 否 String 设备ID 最小长度：1 最大长度：64 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000 最小值：1 最大值：1000 缺省值：10