华为云用户手册

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 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。

响应示例 状态码：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, "channel_cache_state" : "on" }, "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", "tpm_info" : { "manufacturer_id" : "IBM", "spec_version" : "146" }, "runtime_info" : { "enable_tpm" : true }, "os_type" : "generalLinux" }

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

请求示例 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，提供给其他系统访问的唯一标识 name String NA系统名称 description String 北向NA系统描述 endpoint String 访问URL地址 auth_type String 鉴权方式 access_type String 接入类型 access_roma_info AccessRomaBriefInfo object ROMA接入鉴权信息 create_time String 创建时间 update_time String 更新时间 表7 AccessRomaBriefInfo 参数 参数类型 描述 app_key String 认证key，加密存储

响应示例 状态码：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。 edge_node_id 是 String 边缘节点ID 表2 Query参数 参数 是否必选 参数类型 描述 gateway_id 否 String 父设备ID,对应之前的gatewayId的概念，传该参数时代表查询网关下的子设备，不传代表节点下的 device_name 否 String 设备名称 module_id 否 String 设备所属的模块id device_id 否 String 设备ID offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 page_info PageInfoDTO object 分页信息 devices Array of QueryDcDeviceRespDTO objects 每页记录数 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 limit Integer 每页记录数 表6 QueryDcDeviceRespDTO 参数 参数类型 描述 device_id String 设备id

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 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。 表2 Query参数 参数 是否必选 参数类型 描述 device_id 否 String 设备标识码。 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000

响应示例 状态码：200 OK { "id" : "config1", "name" : "配置项1", "value" : "配置项详情1", "description" : "这是一个配置项", "version" : 1603694409089, "state" : "SUC CES S", "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/{config_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 node_id 是 String 边缘节点ID ia_id 是 String 边侧第三方应用的模块ID config_id 是 String 配置ID

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 ProxyPayload 是 Object 代理消息

响应示例 状态码：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 space_id String 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下，否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id. external_id String 外部实体ID protocol String 接入协议类型：MQTT，HTTP。 connection_type String 连接类型(client和server) create_time String 创建时间 last_modify_time String 最后修改时间

请求示例 POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/externals { "external_id" : "test", "protocol" : "MQTT", "connection_type" : "CLIENT", "mqtt_connection_info" : { "server_address" : "ssl://127.0.0.1:88883", "client_id" : "client_id", "auth_type" : "SECRET", "private_key" : "MIIGsDCCBJigAwIBAgIIdrfb4YBBxtQwDQYJKoZIhvcNAQELBQAwgZIxCzAJBgNV", "certificate" : "MIIGsDCCBJigAwIBAgIIdrfb4YBBxtQwDQYJKoZIhvcNAQELBQAwgZIxCzAJBgNV", "user_name" : "user_name", "password" : "password", "qos" : 0 }, "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka" }

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

请求示例 POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/devices/controls/default-values { "devices" : [ { "device_id" : "string", "service_id" : "string", "properties" : { "property1" : "123456", "property2" : 1111 } } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 devices 是 Array of DeviceDefaultValues objects 设备默认值数组 表4 DeviceDefaultValues 参数 是否必选 参数类型 描述 device_id 是 String 设备ID service_id 否 String 服务id，可选 properties 是 Object 属性key和value的map，用于设置属性的值

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 配置项名称 value 是 String 配置项详情，长度2MB以内 description 否 String 配置项描述

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

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

URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/devices/{device_id}/controls/release 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID device_id 是 String 设备ID

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 control_id 是 String 控制id service_id 否 String 服务id，可选 priority 是 Integer 调度计划优先级。 properties 是 Array of strings 控制释放的属性数组

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

URI GET /v2/{project_id}/templates/ots/data-sources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 page_info PageInfoDTO object 分页信息 templates Array of QueryOtTemplateBriefRespDTO objects 每页记录数 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 limit Integer 每页记录数 表6 QueryOtTemplateBriefRespDTO 参数 参数类型 描述 tpl_id String 模板id name String 模板名称 description String 描述 create_time String 创建时间 update_time String 最后一次修改时间

响应示例 状态码：200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "templates" : [ { "tpl_id" : "string", "name" : "string", "description" : "string", "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}/download-template 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。