华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 edge_apps Array of QueryApplicationBriefResponseDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 QueryApplicationBriefResponseDTO 参数 参数类型 描述 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_PRO CES SING|PROTOCOL_PARSING 最小长度：0 最大长度：64 deploy_type String 部署类型docker|process 最小长度：0 最大长度：64 protocol String 驱动协议类型OPCUA|Modbus-TCP 最小长度：0 最大长度：64 edge_app_name String 应用名称 最小长度：0 最大长度：64

URI GET /v2/{project_id}/edge-apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 edge_app_id 否 String 应用ID搜索关键字 最小长度：1 最大长度：32 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0。 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000。 最小值：0 最大值：1000000 缺省值：10 app_type 否 String 应用id搜索关键字 最小长度：0 最大长度：64 枚举值： SYSTEM_REQUIRED SYSTEM_OPTIONAL USER function_type 否 String 功能类型 最小长度：0 最大长度：64 枚举值： DATA_PROCESSING PROTOCOL_PARSING ON_PREMISE_INTEGRATION GATEWAY_MANAGER COMPOSITE_APPLICATION DATA_COLLECTION function_types 否 Array 功能类型列表 数组长度：0 - 1000 protocol 否 String 驱动协议类型搜索关键字 最小长度：1 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 points Array of CreateDcPointRespDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 CreateDcPointRespDTO 参数 参数类型 描述 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 表7 ProcessingConfigDTO 参数 参数类型 描述 validity PointValidityingDTO object 点位校验 stream_formula String 点位流公式配置字段 最小长度：0 最大长度：128 scaling PointScalingDTO object 点位缩放规则列表 clean PointCleanDTO object 点位计算规则列表 表8 PointValidityingDTO 参数 参数类型 描述 min Object 点位上报值的最小值，小于该值则上报告警 max Object 点位上报值的最大值，大于该值则上报告警 outlier_filtering Boolean 异常值过滤 表9 PointScalingDTO 参数 参数类型 描述 ratio Double 缩放的倍率 最小值：-10000 最大值：10000 base Double 基准值 最小值：-10000 最大值：10000 accuracy Integer 缩放后结果的精度，精确到小数点后几位,-1表示全部保留，0表示只保留整数位 最小值：-1 最大值：8 缺省值：-1 表10 PointCleanDTO 参数 参数类型 描述 silent_window Integer 静默时间窗口，在该时间窗口内，没有触发上报条件，点位将不会上 最小值：0 最大值：86400 deviation Double 偏差，在该偏差范围内表示是正常波动，点位将不进行上报 最小值：0 最大值：100

响应示例 状态码： 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "points" : [ { "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 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 point_id 否 String 采集点位表id，创建点位表时设置，数据源下唯一。 最小长度：1 最大长度：64 name 否 String 点位名称，允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符.模糊查询 最小长度：1 最大长度：64 property 否 String 属性，允许中、数字、英文大小写、下划线、中划线，精确查询 最小长度：1 最大长度：128 device_id 否 String 设备标识，精确查询 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000 最小值：0 最大值：1000000 缺省值：10

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

请求示例 PUT https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/points/{point_id} { "name" : "马达电压", "collection_config" : { "address" : "ns=2;s=Root/Motor/Voltage", "data_type" : "int", "cycle" : 10000 }, "device_id" : "MotorVoltage", "property" : "Motor/Voltage", "data_type" : "int", "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参数 参数 是否必选 参数类型 描述 name 否 String 点位名称，允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符 最小长度：1 最大长度：64 collection_config 否 Object 点位采集配置 device_id 是 String 设备id property 是 String 属性，允许中、数字、英文大小写、下划线、中划线 最小长度：0 最大长度：128 data_type 否 String 点位数据类型 最小长度：1 最大长度：32 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

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

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

URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/install 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 arch 是 String 节点架构 最小长度：4 最大长度：16 enable_tpm 否 Boolean 是否启用TPM 缺省值：false

URI GET /v3/{project_id}/apps/{app_id}/versions/{version}/images 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 app_id 是 String 应用ID 最小长度：1 最大长度：32 version 是 String 应用版本 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000。 最小值：1 最大值：1000 缺省值：10 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0。 最小值：0 最大值：1000000 缺省值：0

响应示例 状态码： 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "app_images" : [ { "image_namespace" : "iot", "name" : "edge_manager", "tag" : "1.0.0", "digest" : "sha256:38f3f34301cec3cabd9de3f65f2b313ed7e44d6b211254e7156d12229c5b459f", "create_time" : "string" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 app_images Array of QueryAppImageResponseDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 QueryAppImageResponseDTO 参数 参数类型 描述 image_namespace String 镜像组织 name String 镜像仓库名称 tag String 镜像tag digest String 镜像摘要 create_time String 创建时间

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

响应示例 状态码： 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 OK { "cluster_id" : "123343534", "cluster_name" : "test-cluster", "description" : "this is a test cluster", "version" : "string", "state" : "string", "os" : "string", "arch" : "string", "create_time" : "string", "update_time" : "string", "license" : "string" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 cluster_id String 集群ID cluster_name String 集群名称 最小长度：4 最大长度：32 description String 集群描述 version String 边缘集群版本 state String 边缘集群状态 os String 操作系统 arch String 集群架构 license LicenseInfo object license信息 resource_id String 资源id create_time String 创建时间 最小长度：0 最大长度：256 update_time String 最后一次修改时间 最小长度：0 最大长度：256 表4 LicenseInfo 参数 参数类型 描述 esn String esn码 最小长度：1 最大长度：256 expire_time String 超期时间 最小长度：1 最大长度：256 grace_time String 宽限期 最小长度：0 最大长度：256

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

响应示例 状态码： 201 Created { "cluster_id" : "123343534", "cluster_name" : "test-cluster", "description" : "this is a test cluster", "version" : "string", "state" : "string", "create_time" : "string", "update_time" : "string", "is_upgradeable" : true }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 cluster_name 是 String 集群名称 最小长度：4 最大长度：32 description 否 String 集群描述 最小长度：0 最大长度：1024 cluster_node_config 否 ClusterNodeConfig object 集群节点配置 表4 ClusterNodeConfig 参数 是否必选 参数类型 描述 master_node_vip 否 String master虚拟ip 最小长度：1 最大长度：64 master_nodes 否 Array of NodeConfig objects master节点数 work_nodes 否 Array of NodeConfig objects work节点数 表5 NodeConfig 参数 是否必选 参数类型 描述 node_ip 否 String 节点IP 最小长度：1 最大长度：64 node_name 否 String 节点名称 最小长度：1 最大长度：64

响应参数 状态码： 201 表6 响应Body参数 参数 参数类型 描述 cluster_id String 集群ID cluster_name String 集群名称 最小长度：4 最大长度：32 description String 集群描述 version String 边缘集群版本 state String 边缘集群状态 create_time String 创建时间 最小长度：0 最大长度：256 update_time String 最后一次修改时间 最小长度：0 最大长度：256 is_upgradeable Boolean 是否可升级

请求示例 GET https://{endpoint}/v3/{project_id}/clusters { "cluster_name" : "test-cluster", "description" : "this is a test cluster", "cluster_node_config" : { "master_node_vip" : "string", "master_nodes" : [ { "node_ip" : "string", "node_name" : "string" } ], "work_nodes" : [ { "node_ip" : "string", "node_name" : "string" } ] } }

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

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

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

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

响应示例 状态码： 200 OK { "app_instances" : [ { "id" : "string", "namespace" : "string", "version" : "string", "app_id" : "string", "app_version" : "string", "status" : "string", "status_description" : "string", "values" : { }, "create_time" : "string", "update_time" : "string" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 app_instances Array of QueryAppInstanceResp objects 应用实例列表 数组长度：0 - 1000 表4 QueryAppInstanceResp 参数 参数类型 描述 id String 应用实例ID namespace String 边缘集群命名空间 version String 应用实例版本 app_id String 应用ID app_version String 应用版本 status String 应用实例状态 status_description String 状态描述 values Object 应用实例chart配置 create_time String 创建时间 update_time String 最后一次更新时间