华为云用户手册

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 最后一次更新时间

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表4 FormData参数 参数 是否必选 参数类型 描述 chart 是 File chart包。当前仅支持tgz文件格式。 images 否 String 应用包含的镜像列表

URI POST /v3/{project_id}/apps/{app_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 app_id 是 String 应用ID 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 version 是 String 应用版本 最小长度：1 最大长度：32

响应示例 状态码： 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。 最小长度：1 最大长度：64 node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 ia_id 是 String 边侧第三方应用的模块ID 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：100 缺省值：0 limit 否 Integer 每页记录数，取值范围为非负整数，默认值为10 最小值：1 最大值：100 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 configs Array of QueryIaConfigResponseDTO objects 南向3rdIA配置项列表 数组长度：0 - 100 表5 QueryIaConfigResponseDTO 参数 参数类型 描述 id String 配置ID 最小长度：1 最大长度：32 name String 配置项名称 最小长度：1 最大长度：64 value String 配置项详情 最小长度：1 最大长度：2048 description String 配置项描述 最小长度：0 最大长度：255 version Long 版本号 最小长度：0 最大长度：64 state String 下发状态 枚举值： SUCCESS SENDING create_time String 创建时间 最小长度：0 最大长度：256 update_time String 更新时间 最小长度：0 最大长度：256

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

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

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

URI GET /v3/{project_id}/apps/{app_id}/versions/{version}/archive 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 app_id 是 String 应用ID 最小长度：1 最大长度：32 version 是 String 应用版本 最小长度：1 最大长度：32

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

响应示例 状态码： 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 最小长度：1 最大长度：64 name 是 String 模板名称，允许中、数字、英文大小写、下划线、中划线 最小长度：1 最大长度：64 description 是 String 描述 最小长度：0 最大长度：128 datasource_meta 是 Object 数据源元数据 point_meta 是 Object 点位表元数据

响应参数 状态码： 200 表4 响应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 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 apps Array of QueryAppBriefResponseDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 QueryAppBriefResponseDTO 参数 参数类型 描述 app_id String 应用模板ID 最小长度：1 最大长度：64 description String 应用描述 最小长度：0 最大长度：256 app_type String 应用类型 最小长度：0 最大长度：64 provider_type String 应用来源 最小长度：0 最大长度：64 create_time String 创建时间 最小长度：0 最大长度：256 update_time String 最后一次修改时间 最小长度：0 最大长度：256

响应示例 状态码： 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "apps" : [ { "app_id" : "string", "description" : "string", "app_type" : "string", "provider_type" : "string", "create_time" : "string", "update_time" : "string" } ] }

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

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

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

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

URI PUT /v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}/shadow 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 module_id 是 String 边缘模块ID 最小长度：1 最大长度：64

URI GET /v3/{project_id}/clusters/{cluster_id}/nodes/{node_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 cluster_id 是 String 边缘集群ID 最小长度：1 最大长度：64 node_name 是 String 节点名称 最小长度：1 最大长度：64

响应示例 状态码： 200 OK { "name" : "string", "internal_ip" : "string", "hostname" : "string", "allocatable" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "capacity" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "allocated_resources" : { "request" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "limit" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 } }, "status" : "Ready", "architecture" : "string", "labels" : { }, "node_type" : "string", "kernel_version" : "string", "os_image" : "string", "container_runtime_version" : "string", "kubernetes_version" : "string", "create_time" : "string" }

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

响应示例 状态码： 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。 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String NA名称搜索关键字 最小长度：1 最大长度：64 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：0 缺省值：0 limit 否 Integer 每页记录数，取值范围为非负整数，默认值为10 最小值：10 最大值：10 缺省值：10

URI DELETE /v2/{project_id}/edge-nodes/{node_id}/ias/{ia_id}/configs/{config_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 ia_id 是 String 边侧第三方应用的模块ID 最小长度：1 最大长度：64 config_id 是 String 配置ID 最小长度：1 最大长度：32