华为云用户手册

  • 响应示例 状态码: 201 create { "edge_app_id" : "test-app", "app_version" : "1.0.0", "state" : "PENDING", "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", "container_settings" : { "configs" : { "container_port_list" : [ { "container_port" : 65535, "host_port" : 65535, "host_ip" : "string" } ] } } }
  • 响应参数 状态码: 201 表8 响应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 container_settings ModuleContainerSettingsResDTO object 容器相关配置 表9 ModuleContainerSettingsResDTO 参数 参数类型 描述 configs ContainerConfigsResDTO object 容器相关配置 custom_envs Object 自定义环境变量 extra_hosts Array of DNSConfigDTO objects 域名 解析配置集合 数组长度:0 - 20 表10 ContainerConfigsResDTO 参数 参数类型 描述 host_network Boolean 是否使用主机网络模式 缺省值:false container_port_list Array of ContainerPortDTO objects 容器端口映射值 数组长度:0 - 1000000 表11 ContainerPortDTO 参数 参数类型 描述 container_port Integer 构成一堆映射的容器端口 最小值:1 最大值:65535 host_port Integer 构成一对映射的物理机对应网卡端口 最小值:1 最大值:65535 host_ip String 对应网卡地址 最小长度:0 最大长度:64 表12 DNSConfigDTO 参数 参数类型 描述 hostname String 域名 最小长度:1 最大长度:1024 ip String 域名解析对应IP 最小长度:1 最大长度:64
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 edge_app_id 是 String 边缘应用名称 最小长度:0 最大长度:32 app_version 是 String 边缘应用版本 最小长度:0 最大长度:64 module_name 否 String 边缘模块名称 最小长度:0 最大长度:256 container_settings 否 ContainerSettingsReqDTO object 容器相关配置 表4 ContainerSettingsReqDTO 参数 是否必选 参数类型 描述 configs 否 ContainerConfigsReqDTO object 容器相关配置 custom_envs 否 Object 自定义环境变量 extra_hosts 否 Object 域名解析配置集合 数组长度:0 - 20 表5 ContainerConfigsReqDTO 参数 是否必选 参数类型 描述 container_port_list 否 Array of ContainerPortDTO objects 容器端口映射值 数组长度:0 - 1000000 表6 ContainerPortDTO 参数 是否必选 参数类型 描述 container_port 否 Integer 构成一堆映射的容器端口 最小值:1 最大值:65535 host_port 否 Integer 构成一对映射的物理机对应网卡端口 最小值:1 最大值:65535 host_ip 否 String 对应网卡地址 最小长度:0 最大长度:64 表7 DNSConfigDTO 参数 是否必选 参数类型 描述 hostname 否 String 域名 最小长度:1 最大长度:1024 ip 否 String 域名解析对应IP 最小长度:1 最大长度:64
  • URI GET /v3/{project_id}/clusters/{cluster_id}/app-instances/{app_instance_id}/history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 cluster_id 是 String 边缘集群ID 最小长度:1 最大长度:64 app_instance_id 是 String 应用实例ID 最小长度:1 最大长度:24 表2 Query参数 参数 是否必选 参数类型 描述 namespace 否 String 命名空间 缺省值:default 最小长度:1 最大长度:63
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 history Array of QueryAppInstanceHistoryResponseDTO objects 应用实例历史版本列表 数组长度:0 - 1000 表5 QueryAppInstanceHistoryResponseDTO 参数 参数类型 描述 app_id String 应用ID app_version String 应用版本号 version String 应用实例历史版本号 values Object 应用实例chart配置 update_time String 更新时间
  • URI DELETE /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 表2 Query参数 参数 是否必选 参数类型 描述 namespace 否 String 命名空间 缺省值:default 最小长度:1 最大长度:63
  • URI POST /v3/{project_id}/clusters/{cluster_id}/install-cmd 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 cluster_id 是 String 边缘集群ID 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 arch 是 String 边缘集群架构 最小长度:1 最大长度:16 os 否 String 集群操作系统内核 最小长度:1 最大长度:16
  • URI PUT /v2/{project_id}/edge-nodes/{edge_node_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 device_id 是 String 设备ID 最小长度:1 最大长度:256
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 config 否 Object 设备配置,内容由产品的$config服务定义。
  • URI DELETE /v2/{project_id}/edge-apps/{edge_app_id}/versions/{version} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_app_id 是 String 应用版本,应用内版本唯一。 最小长度:1 最大长度:32 version 是 String 应用版本ID,应用版本唯一。 最小长度:1 最大长度:32
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 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
  • URI GET /v2/{project_id}/nas/{na_id}/nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 na_id 是 String 北向数据接收端点ID 最小长度:1 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:1000000 缺省值:0 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000 最小值:1 最大值:1000 缺省值:10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 nodes Array of QueryAuthorizedNodeDTO objects 查询授权北向NA信息到边缘节点列表的返回结构体 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryAuthorizedNodeDTO 参数 参数类型 描述 node_id String 边缘节点ID 最小长度:1 最大长度:64 authorized_time String 授权时间 最小长度:1 最大长度:64
  • 响应示例 状态码: 200 Ok { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "nodes" : [ { "edge_node_id" : "string", "name" : "string", "state" : "string", "instance_id" : "string", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "type" : "string", "resource_ids" : [ "iotedge.campus.1000tps.10000device" ], "resource_spec_types" : [ "iotedge.campus.1000tps.10000device" ], "software_version" : "string", "ips" : [ "string" ], "create_time" : "2020-05-28T11:31:29.740Z" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 nodes Array of EdgeNodeDTO objects 节点列表 数组长度:0 - 1000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 EdgeNodeDTO 参数 参数类型 描述 edge_node_id String 边缘节点ID 最小长度:1 最大长度:64 name String 边缘节点名称 最小长度:1 最大长度:64 state String 边缘节点状态UNINSTALLED|INSTALLED|OFFLINE|ONLINE|DELETING|FROZEN 最小长度:4 最大长度:32 instance_id String 实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。 最小长度:1 最大长度:36 space_id String 资源空间id,对应IOTDA云服务接口参数中的app_id。 最小长度:1 最大长度:64 type String 边缘节点类型:lite|advanced|standard。lite表示基础版边缘节点,advanced或standard表示专业版边缘节点。 最小长度:4 最大长度:16 resource_ids Array of strings 节点所购买的资源类型的列表 最小长度:4 最大长度:16 resource_spec_types Array of strings 节点所购买的资源类型的列表 最小长度:4 最大长度:16 ips Array of strings 边缘节点ip列表 数组长度:0 - 10 software_version String 节点软件版本 最小长度:4 最大长度:32 create_time String 边缘节点创建时间 最小长度:0 最大长度:256
  • URI GET /v2/{project_id}/edge-nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 节点名称 最小长度:1 最大长度:64 state 否 String 节点状态,OFFLINE|ONLINE|UNINSTALLED|INSTALLED|DELETING|UPGRADING|FROZEN 最小长度:1 最大长度:32 type 否 String 节点所属资源类型,advanced|standard 最小长度:1 最大长度:32 instance_id 否 String 实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。 最小长度:1 最大长度:36 space_id 否 String 资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,可以携带该参数查询指定资源空间下的设备列表,不携带该参数则会查询该用户下所有设备列表。 最小长度:1 最大长度:36 node_ids 否 Array 节点id列表,查询ID在给的节点ID列表内的节点信息 数组长度:0 - 1000 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:1000000 缺省值:0 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000 最小值:1 最大值:1000 缺省值:10
  • 响应示例 状态码: 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "modules" : [ { "edge_app_id" : "test-app", "app_version" : "1.0.0", "state" : "PENDING", "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_PROCESSING" } ] }
  • URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/modules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:1000000 缺省值:0 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000 最小值:1 最大值:1000 缺省值:10 app_type 否 String 应用类型 最小长度: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_types 否 Array 协议类型列表 数组长度:0 - 100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 modules Array of EdgeModuleDTO objects 每页记录数 数组长度:0 - 1000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 EdgeModuleDTO 参数 参数类型 描述 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认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 是 String 应用ID 最小长度:4 最大长度:32 app_name 否 String 应用名称 最小长度:4 最大长度:64 description 否 String 应用描述 最小长度:1 最大长度:255 app_type 是 String 应用类型 最小长度:1 最大长度:64
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 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 表8 响应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
  • 响应示例 状态码: 200 OK { "edge_app_id" : "test-app", "app_version" : "1.1.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_PROCESSING" }
  • 请求示例 PUT https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id} { "app_version" : "1.1.0", "module_name" : "edge_module", "container_settings" : { "configs" : { "container_port_list" : [ { "container_port" : 65535, "host_port" : 65535, "host_ip" : "string" } ] } }, "desired_state" : "RUNNING" }
  • URI PUT /v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 module_id 是 String 边缘模块ID 最小长度:1 最大长度:64
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 app_version 否 String 边缘应用版本 最小长度:0 最大长度:64 module_name 否 String 边缘模块名称 最小长度:0 最大长度:256 desired_state 否 String 模块期望状态: RUNNING(升级后期望模块运行),STOPPED(升级后期望模块停止),空值默认继承升级前模块期望状态 最小长度:0 最大长度:64 枚举值: RUNNING STOPPED container_settings 否 ContainerSettingsReqDTO object 容器设置 表4 ContainerSettingsReqDTO 参数 是否必选 参数类型 描述 configs 否 ContainerConfigsReqDTO object 容器相关配置 custom_envs 否 Object 自定义环境变量 extra_hosts 否 Object 域名解析配置集合 数组长度:0 - 20 表5 ContainerConfigsReqDTO 参数 是否必选 参数类型 描述 container_port_list 否 Array of ContainerPortDTO objects 容器端口映射值 数组长度:0 - 1000000 表6 ContainerPortDTO 参数 是否必选 参数类型 描述 container_port 否 Integer 构成一堆映射的容器端口 最小值:1 最大值:65535 host_port 否 Integer 构成一对映射的物理机对应网卡端口 最小值:1 最大值:65535 host_ip 否 String 对应网卡地址 最小长度:0 最大长度:64 表7 DNSConfigDTO 参数 是否必选 参数类型 描述 hostname 否 String 域名 最小长度:1 最大长度:1024 ip 否 String 域名解析对应IP 最小长度:1 最大长度:64
  • 请求示例 POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/devices { "node_id" : "ABC123456789", "device_name" : "dianadevice", "product_id" : "b640f4c203b7910fc3cbd446ed437cbd", "auth_info" : { "auth_type" : "SECRET", "secret" : "3b935a250c50dc2c6d481d048cefdc3c", "fingerprint" : "dc0f1016f495157344ac5f1296335cff725ef22f", "secure_access" : true, "timeout" : 300 }, "description" : "watermeter device", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "extension_info" : { "aaa" : "xxx", "bbb" : 0 }, "config" : { "ip" : "127.0.0.1" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 node_id 是 String 设备标识码,通常使用IMEI、MAC地址或Serial No作为node_id。(注意:NB设备由于模组烧录信息后无法配置,所以NB设备会校验node_id全局唯一。) 最小长度:1 最大长度:64 device_name 否 String 设备名称。 最小长度:1 最大长度:256 product_id 是 String 设备关联的产品ID,用于唯一标识一个产品模型,在管理门户导入产品模型后由平台分配获得。 auth_info 否 EdgeDeviceAuthInfo object 设备的接入认证信息。 description 否 String 设备的描述信息。 最大长度:2048 gateway_id 否 String 父设备ID,用于标识设备所属的父设备。携带该参数时,表示在该父设备下创建一个子设备,这个子设备不与平台直连,此时必须保证这个父设备在平台已存在,创建成功后子设备的gateway_id等于该参数值;不携带该参数时,表示创建一个和平台直连的设备,创建成功后设备的device_id和gateway_id一致。 space_id 否 String 资源空间Id。此参数为非必选参数,用于兼容平台老用户存在多应用的场景。存在多应用的用户需要使用该接口时,必须携带该参数指定注册的设备归属到哪个应用下,否则接口会提示错误。如果用户存在多应用,同时又不想携带该参数,可以联系华为技术支持对用户数据做应用合并。 extension_info 否 Object 设备扩展信息。用户可以自定义任何想要的扩展信息,如果在创建设备时为子设备指定该字段,将会通过MQTT接口“平台通知网关子设备新增“将该信息通知给网关。字段值大小上限为1K。 config 否 Object 设备初始配置。用户使用该字段可以为设备指定初始配置,指定后将会根据service_id和desired设置的属性值与产品中对应属性的默认值比对,如果不同,则将以设置的属性值为准写入到设备配置中。 表4 EdgeDeviceAuthInfo 参数 是否必选 参数类型 描述 auth_type 否 String 鉴权类型。支持密钥认证接入(SECRET)和证书认证接入(CERTIFICATES)两种方式。使用密钥认证接入方式(SECRET)填写secret字段,使用证书认证接入方式(CERTIFICATES)填写fingerprint字段,不填写auth_type默认为密钥认证接入方式(SECRET) secret 否 String 设备密钥,认证类型使用密钥认证接入(SECRET)可填写该字段。注意:NB设备密钥由于协议特殊性,只支持十六进制密钥接入;修改设备、查询设备及查询设备列表接口不返回该参数。 最小长度:8 最大长度:32 fingerprint 否 String 证书指纹,认证类型使用证书认证接入(CERTIFICATES)可填写该字段,注册设备时不填写该字段则取第一次设备接入时的证书指纹。注意:指纹只能为40位十六进制字符串或者64位十六进制字符串;修改设备、查询设备及查询设备列表接口不返回该参数。 secure_access 否 Boolean 指设备是否通过安全协议方式接入,默认值为true。 true:通过安全协议方式接入。 false:通过非安全协议方式接入。 缺省值:true timeout 否 Integer 设备验证码的有效时间,单位:秒,默认值:0 若设备在有效时间内未接入 物联网平台 并激活,则平台会删除该设备的注册信息。若设置为“0”,则表示设备验证码不会失效(建议填写为“0”)。注意:只有注册设备接口或者修改设备接口修改timeout时返回该参数。 最小值:0 最大值:2147483647 缺省值:0
  • 响应示例 状态码: 200 Ok { "routes" : [ { "route_id" : "string", "input_module_id" : "string", "output_module_id" : "string", "input" : "string", "output" : "string", "sql" : "string", "available" : true } ], "update_time" : "2020-05-28T11:31:29.740Z" }
  • URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/routes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 parsed 否 Boolean 是否解析路由 缺省值:false
共100000条