华为云用户手册

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

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

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

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

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

响应示例 状态码： 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}/ots/data-sources/{ds_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 device_id 否 String 设备标识码。 最小长度：1 最大长度：128 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000 最小值：0 最大值：1000000 缺省值：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

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 配置ID 最小长度：1 最大长度：32 name String 配置项名称 最小长度：1 最大长度：64 value String 配置项详情 最小长度：1 最大长度：2048 description String 配置项描述 最小长度：0 最大长度：255 version Long 版本号 最小长度：0 最大长度：64 state String 下发状态 枚举值： SUC CES S SENDING create_time String 创建时间 最小长度：0 最大长度：256 update_time String 更新时间 最小长度：0 最大长度：256

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 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 最后一次更新时间

请求示例 PUT https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/app-instances/{app_instance_id} { "action" : "string", "namespace" : "string", "app_version" : "string", "values" : { }, "rollback_version" : "string" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 动作类型 namespace 否 String 命名空间，应用实例部署于非默认命名空间(default)时必填 最小长度：1 最大长度：63 app_version 否 String 升级的目标版本号，动作类型为upgrade时必填 最小长度：1 最大长度：32 values 否 Object 应用实例chart配置，动作类型为upgrade时必填 rollback_version 否 String 回退的目标版本号，动作类型为rollback时必填 最小长度：1 最大长度：32

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

URI PUT /v3/{project_id}/clusters/{cluster_id}/app-instances/{app_instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 cluster_id 是 String 边缘集群ID 最小长度：1 最大长度：64 app_instance_id 是 String 应用实例ID 最小长度：1 最大长度：24

响应示例 状态码： 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "app_versions" : [ { "app_id" : "string", "version" : "string", "values" : { }, "create_time" : "string", "update_time" : "string" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 app_versions Array of QueryAppVersionResponseDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 QueryAppVersionResponseDTO 参数 参数类型 描述 app_id String 应用模板ID version String 应用版本 values Object 应用版本配置 create_time String 创建时间 update_time String 最后一次修改时间

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

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

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

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