华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 protocol 是 String 连接外部实体的协议类型 connection_type 是 String 连接类型 mqtt_connection_info 否 MqttConnectionInfo object mqtt连接信息 表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
  • 响应示例 状态码: 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "templates" : [ { "tpl_id" : "gernal_app_tpl", "name" : "gernal_app_tpl", "description" : "this is a gernal template", "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z" } ] }
  • URI GET /v2/{project_id}/templates/apps/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 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 分页信息 templates Array of QueryAppConfigsTemplateBriefRespDTO objects 模板列表 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryAppConfigsTemplateBriefRespDTO 参数 参数类型 描述 tpl_id String 模板id 最小长度:1 最大长度:64 name String 模板名称 最小长度:1 最大长度:64 description String 描述 最小长度:0 最大长度:128 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256
  • 响应示例 状态码: 200 OK { "edge_app_id" : "test-app", "app_version" : "1.0.0", "state" : "RUNNING", "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" }
  • URI PUT /v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}/state 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 module_id 是 String 边缘模块ID 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表4 响应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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 state 否 String 模块状态 枚举值: RUNNING STOPPED
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 configs 否 Array of BatchImportConfigRequestBody objects 南向IA配置项列表 数组长度:0 - 100 表4 BatchImportConfigRequestBody 参数 是否必选 参数类型 描述 id 是 String 配置项ID 最小长度:1 最大长度:32 name 是 String 配置项名称 最小长度:1 最大长度:64 value 是 String 配置项详情,长度2MB以内 最小长度:1 最大长度:2097152 description 否 String 配置项描述 最小长度:0 最大长度:255
  • 请求示例 POST https://{endpoint}/v2/{project_id}/edge-nodes/{node_id}/ias/{ia_id}/configs/batch-import { "configs" : [ { "id" : "config1", "name" : "配置项1", "value" : "配置项详情1", "description" : "这是一个配置项" } ] }
  • URI POST /v2/{project_id}/edge-nodes/{node_id}/ias/{ia_id}/configs/batch-import 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 ia_id 是 String 边侧第三方应用的模块ID 最小长度:1 最大长度:64
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 node_info 否 Array of NodeConfig objects 集群节点名称列表 数组长度:1 - 64 表4 NodeConfig 参数 是否必选 参数类型 描述 node_ip 否 String 节点IP 最小长度:1 最大长度:64 node_name 否 String 节点名称 最小长度:1 最大长度:64
  • 响应参数 状态码: 201 表20 响应Body参数 参数 参数类型 描述 channel_id String 推送通道ID name String 推送通道名称 channel String 通道 description String 推送通道描述 endpoint String 推送的地址 mqtt_channel_detail MqttChannelDetailDTO object MQTT通道详情 iotdb_channel_detail IoTDBChannelDetailDTO object IoTDB通道详情 influxdb2_channel_detail CreateInfluxDB2ChannelDetail object MQTT通道配置详情 pulsar_channel_detail PulsarChannelDetailDTO object Pulsar通道详情 create_time String 创建时间 update_time String 更新时间 表21 MqttChannelDetailDTO 参数 参数类型 描述 connection_info MqttConnectionInfoResp object 外部推送通道返回详情 push_info MqttPushInfoResp object MQTT推送信息详情 表22 MqttConnectionInfoResp 参数 参数类型 描述 username String 鉴权用户名 trust_certs Object 客户端信任证书列表 verify_hostname Boolean 客户端是否开启校验 域名 表23 MqttPushInfoResp 参数 参数类型 描述 device_data DeviceMqttPushInfoDetail object 设备数据推送MQTT详情 表24 DeviceMqttPushInfoDetail 参数 参数类型 描述 topic String client推送的topic 最小长度:1 最大长度:256 format String 数据格式转换类型 最小长度:1 最大长度:32 qos Integer MQTT的服务质量 最小值:0 最大值:2 表25 IoTDBChannelDetailDTO 参数 参数类型 描述 connection_info IoTDBConnectionInfoResp object 创建外部推送通道请求结构体 push_info IoTDBPushInfoResp object IoTDB推送信息详情 表26 IoTDBConnectionInfoResp 参数 参数类型 描述 username String 鉴权用户名 password String 鉴权密码 表27 IoTDBPushInfoResp 参数 参数类型 描述 device_data DeviceIoTDBPushInfoDetail object 创建设备数据推送IoTDB 表28 DeviceIoTDBPushInfoDetail 参数 参数类型 描述 storage_group String 数据存储的存储组 最小长度:1 最大长度:32 format String 数据格式转换类型 最小长度:1 最大长度:32 表29 CreateInfluxDB2ChannelDetail 参数 参数类型 描述 connection_info InfluxDB2ConnectionInfo object 创建外部推送通道请求结构体 push_info InfluxDB2PushInfo object 创建IoTDB推送信息 表30 InfluxDB2ConnectionInfo 参数 参数类型 描述 token String 鉴权token 最小长度:1 最大长度:128 trust_certs Object 客户端信任证书列表 数组长度:0 - 5 verify_hostname Boolean 客户端是否开启校验域名 缺省值:true 表31 InfluxDB2PushInfo 参数 参数类型 描述 device_data DeviceInfluxDB2PushInfo object 创建设备数据推送MQTT 表32 DeviceInfluxDB2PushInfo 参数 参数类型 描述 organization String 一组用户的工作空间,一组用户下可以创建多个bucket 最小长度:1 最大长度:32 bucket String 数据存储的地方,结合了数据库和存储周期的概念 最小长度:1 最大长度:32 format String 数据格式转换类型 缺省值:iotda_1.0 最小长度:1 最大长度:32 表33 PulsarChannelDetailDTO 参数 参数类型 描述 connection_info PulsarConnectionInfoResp object 外部推送通道返回详情 push_info PulsarPushInfoResp object Pulsar推送信息详情 表34 PulsarConnectionInfoResp 参数 参数类型 描述 token String 鉴权token 最小长度:1 最大长度:128 表35 PulsarPushInfoResp 参数 参数类型 描述 device_data DevicePulsarPushInfoDetail object 设备数据推送Pulsar详情 表36 DevicePulsarPushInfoDetail 参数 参数类型 描述 topic String client推送的topic 最小长度:1 最大长度:256
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 channel_id 否 String 推送通道ID,非必填,若用户不填,则系统自动生成 最小长度:1 最大长度:64 channel 是 String 通道 name 是 String 推送通道名称 最小长度:1 最大长度:64 description 否 String 推送通道描述 最小长度:0 最大长度:255 endpoint 是 String 推送的地址 最小长度:1 最大长度:256 mqtt_channel_detail 否 CreateMqttChannelDetail object MQTT通道配置详情 iotdb_channel_detail 否 CreateIoTDBChannelDetail object MQTT通道配置详情 influxdb2_channel_detail 否 CreateInfluxDB2ChannelDetail object MQTT通道配置详情 pulsar_channel_detail 否 CreatePulsarChannelDetail object Pulsar通道配置详情 表4 CreateMqttChannelDetail 参数 是否必选 参数类型 描述 connection_info 是 MqttConnectionInfo object 创建外部推送通道请求结构体 push_info 是 MqttPushInfo object 创建MQTT推送信息 表5 MqttConnectionInfo 参数 是否必选 参数类型 描述 username 是 String 鉴权用户名 最小长度:1 最大长度:128 password 是 String 鉴权密码 最小长度:8 最大长度:128 trust_certs 否 Object 客户端信任证书列表 数组长度:0 - 5 verify_hostname 否 Boolean 客户端是否开启校验域名 缺省值:true 表6 MqttPushInfo 参数 是否必选 参数类型 描述 device_data 否 DeviceMqttPushInfo object 创建设备数据推送MQTT 表7 DeviceMqttPushInfo 参数 是否必选 参数类型 描述 topic 是 String client推送的topic 最小长度:1 最大长度:256 format 否 String 数据格式转换类型 缺省值:iotda_1.0 最小长度:1 最大长度:32 qos 否 Integer Mqtt的服务质量 最小值:0 最大值:2 缺省值:0 表8 CreateIoTDBChannelDetail 参数 是否必选 参数类型 描述 connection_info 是 IoTDBConnectionInfo object 创建外部推送通道请求结构体 push_info 是 IoTDBPushInfo object 创建IoTDB推送信息 表9 IoTDBConnectionInfo 参数 是否必选 参数类型 描述 username 是 String 鉴权用户名 最小长度:1 最大长度:128 password 是 String 鉴权密码 最小长度:8 最大长度:128 表10 IoTDBPushInfo 参数 是否必选 参数类型 描述 device_data 否 DeviceIoTDBPushInfo object 创建设备数据推送IoTDB 表11 DeviceIoTDBPushInfo 参数 是否必选 参数类型 描述 storage_group 是 String 数据存储的存储组 最小长度:1 最大长度:32 format 是 String 数据格式转换类型 缺省值:iotda_1.0 最小长度:1 最大长度:32 表12 CreateInfluxDB2ChannelDetail 参数 是否必选 参数类型 描述 connection_info 是 InfluxDB2ConnectionInfo object 创建外部推送通道请求结构体 push_info 是 InfluxDB2PushInfo object 创建IoTDB推送信息 表13 InfluxDB2ConnectionInfo 参数 是否必选 参数类型 描述 token 是 String 鉴权token 最小长度:1 最大长度:128 trust_certs 否 Object 客户端信任证书列表 数组长度:0 - 5 verify_hostname 否 Boolean 客户端是否开启校验域名 缺省值:true 表14 InfluxDB2PushInfo 参数 是否必选 参数类型 描述 device_data 否 DeviceInfluxDB2PushInfo object 创建设备数据推送MQTT 表15 DeviceInfluxDB2PushInfo 参数 是否必选 参数类型 描述 organization 是 String 一组用户的工作空间,一组用户下可以创建多个bucket 最小长度:1 最大长度:32 bucket 是 String 数据存储的地方,结合了数据库和存储周期的概念 最小长度:1 最大长度:32 format 是 String 数据格式转换类型 缺省值:iotda_1.0 最小长度:1 最大长度:32 表16 CreatePulsarChannelDetail 参数 是否必选 参数类型 描述 connection_info 是 PulsarConnectionInfo object 创建外部推送通道请求结构体 push_info 是 PulsarPushInfo object 创建Pulsar推送信息 表17 PulsarConnectionInfo 参数 是否必选 参数类型 描述 token 是 String 鉴权token 最小长度:1 最大长度:128 表18 PulsarPushInfo 参数 是否必选 参数类型 描述 device_data 否 DevicePulsarPushInfo object 创建设备数据推送Pulsar 表19 DevicePulsarPushInfo 参数 是否必选 参数类型 描述 topic 是 String client推送的topic 最小长度:1 最大长度:256
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 ProxyPayload 是 Object 代理消息
  • URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}/proxy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 module_id 是 String 边缘模块ID 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 resource_list Array of ResourceDetail objects 查询资源列表返回消息体 数组长度:0 - 10 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 ResourceDetail 参数 参数类型 描述 resource_id String 资源id,添加资源时由边缘侧生成 最小长度:0 最大长度:64 status String 资源状态,冻结:freeze、解冻:unfreeze、退订:delete。 最小长度:0 最大长度:32 charging_rule String 计费规则 最小长度:0 最大长度:64 type String 内部类型 最小长度:0 最大长度:64 resource_name String 资源名称,由边缘侧生成。 最小长度:0 最大长度:32 cloud_service_type String 公有云CBC上注册的服务类型英文名 最小长度:1 最大长度:64 resource_type String CBC上注册的资源类型编码。 最小长度:1 最大长度:64 resource_spec_code String 资源规格编码 最小长度:1 最大长度:64 associated_edge_cluster_id String 关联的边缘集群ID 最小长度:0 最大长度:64
  • URI GET /v3/{project_id}/resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 resource_group 否 String 查询资源组 最小长度:1 最大长度:64 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:10000 缺省值:0 limit 否 Integer 每页记录数,默认值为10,取值区间为1-100 最小值:1 最大值:100 缺省值:10
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表4 请求Body参数 参数 是否必选 参数类型 描述 configs 否 Array of ConfirmIaConfigRequestBody objects 确认配置项列表 数组长度:0 - 100 表5 ConfirmIaConfigRequestBody 参数 是否必选 参数类型 描述 id 是 String 配置项ID 最小长度:0 最大长度:64 version 是 String 版本号 最小长度:0 最大长度:64
  • URI POST /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参数 参数 是否必选 参数类型 描述 action 是 String confirm 最小长度:1 最大长度:64
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 X-Forward-Target 是 String 透传的k8s的API,{method} {uri}?{query_param} X-Forward-Headers 是 String 透传的API的header
  • 请求示例 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认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 devices 是 Array of DeviceDefaultValues objects 设备默认值数组 表4 DeviceDefaultValues 参数 是否必选 参数类型 描述 device_id 是 String 设备ID 最小长度:1 最大长度:128 service_id 否 String 服务id,可选 properties 是 Object 属性key和value的map,用于设置属性的值
  • URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/devices/controls/default-values 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表12 响应Body参数 参数 参数类型 描述 channel String 通道 description String 推送通道描述 endpoint String 推送的地址 mqtt_channel_detail MqttNodeChannelDetailDTO object MQTT通道详情 iotdb_channel_detail IoTDBNodeChannelDetailDTO object IoTDB通道详情 influxdb2_channel_detail InfluxDB2NodeChannelDetailDTO object MQTT通道配置详情 pulsar_channel_detail PulsarNodeChannelDetailDTO object Pulsar通道详情 create_time String 创建时间 update_time String 更新时间 synchronized_time String 下发时间,表示通道是否已经同步到了节点 synchronized_status Boolean 下发状态,表示是否已同步到了节点 表13 MqttNodeChannelDetailDTO 参数 参数类型 描述 connection_info MqttNodeChannelConnectionInfoResp object 外部推送通道返回详情 push_info MqttNodeChannelPushInfoRsp object MQTT推送信息详情 表14 MqttNodeChannelConnectionInfoResp 参数 参数类型 描述 client_id String mqtt协议中的ClientId username String 鉴权用户名 trust_certs Object 客户端信任证书列表 verify_hostname Boolean 客户端是否开启校验域名 表15 MqttNodeChannelPushInfoRsp 参数 参数类型 描述 device_data DeviceMqttNodeChannelPushInfoDetail object 设备数据推送MQTT详情 表16 DeviceMqttNodeChannelPushInfoDetail 参数 参数类型 描述 topic String client推送的topic 最小长度:1 最大长度:256 qos Integer Mqtt的服务质量 最小值:0 最大值:2 表17 IoTDBNodeChannelDetailDTO 参数 参数类型 描述 connection_info IoTDBConnectionInfoResp object 创建外部推送通道请求结构体 push_info IoTDBNodeChannelPushInfoResp object IoTDB推送信息详情 表18 IoTDBConnectionInfoResp 参数 参数类型 描述 username String 鉴权用户名 password String 鉴权密码 表19 IoTDBNodeChannelPushInfoResp 参数 参数类型 描述 device_data DeviceIoTDBNodeChannelPushInfoDetail object 创建设备数据推送IoTDB 表20 DeviceIoTDBNodeChannelPushInfoDetail 参数 参数类型 描述 storage_group String 数据存储的存储组 最小长度:1 最大长度:32 表21 InfluxDB2NodeChannelDetailDTO 参数 参数类型 描述 connection_info InfluxDB2ConnectionInfo object 创建外部推送通道请求结构体 push_info InfluxDB2NodeChannelPushInfoRsp object 创建IoTDB推送信息 表22 InfluxDB2ConnectionInfo 参数 参数类型 描述 token String 鉴权token 最小长度:1 最大长度:128 trust_certs Object 客户端信任证书列表 数组长度:0 - 5 verify_hostname Boolean 客户端是否开启校验域名 缺省值:true 表23 InfluxDB2NodeChannelPushInfoRsp 参数 参数类型 描述 device_data DeviceInfluxDB2NodeChannelPushInfoDetail object 创建设备数据推送InfluxDB2 表24 DeviceInfluxDB2NodeChannelPushInfoDetail 参数 参数类型 描述 organization String 一组用户的工作空间,一组用户下可以创建多个bucket 最小长度:1 最大长度:32 bucket String 数据存储的地方,结合了数据库和存储周期的概念 最小长度:1 最大长度:32 表25 PulsarNodeChannelDetailDTO 参数 参数类型 描述 connection_info PulsarNodeChannelConnectionInfoResp object 外部推送通道返回详情 push_info PulsarNodeChannelPushInfoRsp object Pulsar推送信息详情 表26 PulsarNodeChannelConnectionInfoResp 参数 参数类型 描述 token String 鉴权token 最小长度:1 最大长度:128 表27 PulsarNodeChannelPushInfoRsp 参数 参数类型 描述 device_data DevicePulsarNodeChannelPushInfoDetail object 设备数据推送Pulsar详情 表28 DevicePulsarNodeChannelPushInfoDetail 参数 参数类型 描述 topic String client推送的topic 最小长度:1 最大长度:256
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 mqtt_channel_detail 否 UpdateMqttNodeChannelDetail object 更新MQTT推送通道详情请求结构体 pulsar_channel_detail 否 UpdatePulsarNodeChannelDetail object 更新Pulsar推送通道详情请求结构体 表4 UpdateMqttNodeChannelDetail 参数 是否必选 参数类型 描述 connection_info 否 UpdateMqttNodeChannelConnectionInfo object 更新外部推送通道请求结构体 push_info 否 UpdateMqttNodeChannelPushInfoDTO object MQTT推送信息详情 表5 UpdateMqttNodeChannelConnectionInfo 参数 是否必选 参数类型 描述 client_id 否 String mqtt协议中的ClientId 最小长度:1 最大长度:256 username 否 String 鉴权用户名 最小长度:1 最大长度:128 password 否 String 鉴权密码 最小长度:8 最大长度:164 trust_certs 否 Object 客户端信任证书列表 数组长度:0 - 5 verify_hostname 否 Boolean 客户端是否开启校验域名 表6 UpdateMqttNodeChannelPushInfoDTO 参数 是否必选 参数类型 描述 device_data 否 DeviceMqttNodeChannelPushInfoDetail object 设备数据推送MQTT详情 表7 DeviceMqttNodeChannelPushInfoDetail 参数 是否必选 参数类型 描述 topic 否 String client推送的topic 最小长度:1 最大长度:256 qos 否 Integer Mqtt的服务质量 最小值:0 最大值:2 表8 UpdatePulsarNodeChannelDetail 参数 是否必选 参数类型 描述 connection_info 否 UpdatePulsarNodeChannelConnectionInfo object 更新外部推送通道请求结构体 push_info 否 UpdatePulsarNodeChannelPushInfoDTO object Pulsar推送信息详情 表9 UpdatePulsarNodeChannelConnectionInfo 参数 是否必选 参数类型 描述 token 否 String 鉴权token 最小长度:1 最大长度:128 表10 UpdatePulsarNodeChannelPushInfoDTO 参数 是否必选 参数类型 描述 device_data 否 DevicePulsarNodeChannelPushInfoDetail object 设备数据推送Pulsar详情 表11 DevicePulsarNodeChannelPushInfoDetail 参数 是否必选 参数类型 描述 topic 否 String client推送的topic 最小长度:1 最大长度:256
  • URI PUT /v2/{project_id}/push-channels/{channel_id}/client-nodes/{node_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 channel_id 是 String 边缘推送通道ID 最小长度:1 最大长度:64 node_id 是 String 边缘节点ID 最小长度:1 最大长度:64
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 node_id 否 String 资源所关联节点ID 最小长度:1 最大长度:64
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 resource_id String 资源ID 最小长度:1 最大长度:64 type String 资源类型:industry|campus 最小长度:1 最大长度:64 subsystem_count Integer 对接的子系统数量 最小值:1 最大值:50 resource_type String CBC上注册的资源类型编码。 最小长度:1 最大长度:64 resource_spec_type String CBC上注册的资源类型编码。 最小长度:1 最大长度:64 associated_edge_node_id String 关联的边缘节点ID 最小长度:0 最大长度:64 associated_edge_node_name String 关联的边缘节点名称 最小长度:0 最大长度:64 extend_params String 扩展开通参数。 最小长度:0 最大长度:1024 resource_size Integer 资源容量大小,线性产品使用
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表4 请求Body参数 参数 是否必选 参数类型 描述 device_secret 否 String 边缘节点设备密钥,如果不输入则平台随机生成 最小长度:8 最大长度:32 verify_code 否 String 边缘节点注册使用的验证码,如果不输入则平台随机生成。 最小长度:1 最大长度:36
共100000条