华为云用户手册

  • 响应参数 状态码: 200 表4 响应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
  • URI PUT /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 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 GET /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
  • 响应示例 状态码: 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 最小值: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 QueryOtTemplateBriefRespDTO objects 每页记录数 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryOtTemplateBriefRespDTO 参数 参数类型 描述 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 { "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 最小长度:1 最大长度:64 ds_id 是 String 采集数据源id,创建数据源配置时设置,节点下唯一。 最小长度:1 最大长度:64
  • 响应示例 状态码: 200 应用配置模板数据 { "tpl_id" : "general_app_tpl", "name" : "general_app_tpl", "description" : "通用应用模板", "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" : { "appname" : "LINK" } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tpl_id String 模板id 最小长度:1 最大长度:64 name String 模板名称 最小长度:1 最大长度:64 description String 描述 最小长度:0 最大长度:128 config_tabs Object 配置项数据 default_values Object 默认数据 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256
  • Token认证 Token是服务端生成的一串字符串,作为客户端进行请求的一个令牌。第一次登录后,服务器生成一个Token并将此Token返回给客户端,以后客户端只需带上这个Token前来请求数据即可,无需再次带上用户名和密码。Token有效期是24小时,从客户端获取开始算起(24小时是相对时间),需要使用同一个Token鉴权时,建议缓存起来使用,避免频繁调用。在Token过期前,务必刷新Token或重新 获取Token ,否则Token过期后会在服务端鉴权失败。 如果您获取Token多次,这些获取的Token在24内均有效。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。Token请求返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值为获取到的Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 GET https://{Endpoint}/v2/{project_id}/nas/{na_id} Content-Type: application/json X-Auth-Token: ABCDEFJ....
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 point_id String 点位表id,数据源下唯一 最小长度:1 最大长度:64 name String 点位名称,允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符 最小长度:1 最大长度:64 collection_config Object 点位采集配置 device_id String 设备id property String 属性,允许中、数字、英文大小写、下划线、中划线 最小长度:1 最大长度:128 data_type String 点位数据类型 最小长度:1 最大长度:32 ds_id String 采集数据源id,节点下唯一 最小长度:1 最大长度:64 processing_config ProcessingConfigDTO object 点位处理配置 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 表5 ProcessingConfigDTO 参数 参数类型 描述 validity PointValidityingDTO object 点位校验 stream_formula String 点位流公式配置字段 最小长度:0 最大长度:128 scaling PointScalingDTO object 点位缩放规则列表 clean PointCleanDTO object 点位计算规则列表 表6 PointValidityingDTO 参数 参数类型 描述 min Object 点位上报值的最小值,小于该值则上报告警 max Object 点位上报值的最大值,大于该值则上报告警 outlier_filtering Boolean 异常值过滤 表7 PointScalingDTO 参数 参数类型 描述 ratio Double 缩放的倍率 最小值:-10000 最大值:10000 base Double 基准值 最小值:-10000 最大值:10000 accuracy Integer 缩放后结果的精度,精确到小数点后几位,-1表示全部保留,0表示只保留整数位 最小值:-1 最大值:8 缺省值:-1 表8 PointCleanDTO 参数 参数类型 描述 silent_window Integer 静默时间窗口,在该时间窗口内,没有触发上报条件,点位将不会上 最小值:0 最大值:86400 deviation Double 偏差,在该偏差范围内表示是正常波动,点位将不进行上报 最小值:0 最大值:100
  • 响应示例 状态码: 200 OK { "point_id" : "MotorVoltage", "name" : "马达电压", "collection_config" : { "address" : "ns=2;s=Root/Motor/Voltage", "data_type" : "int", "cycle" : 10000 }, "device_id" : "MotorVoltage", "property" : "Motor/Voltage", "data_type" : "int", "ds_id" : "opcua_1", "processing_config" : { "validity" : { "min" : 60, "max" : 100 }, "stream_formula" : "bit(0).bool()|string_to_double(-1.0)|string_to_int(0)", "scaling" : { "ratio" : 1, "base" : 100, "accuracy" : 2 }, "clean" : { "silent_window" : 60, "deviation" : 0.1 } }, "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}/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 设备服务属性,允许中、数字、英文大小写、下划线、中划线 最小长度:0 最大长度:128
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 externals Array of ExternalEntityRespDTO objects 外部实体列表 数组长度:0 - 10 表5 ExternalEntityRespDTO 参数 参数类型 描述 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
  • URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/externals 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:0 缺省值:0 limit 否 Integer 每页记录数,取值范围为非负整数,默认值为10 最小值:10 最大值:10 缺省值:10
  • 响应示例 状态码: 200 Ok { "externals" : [ { "node_id" : "string", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "external_id" : "string", "protocol" : "string", "connection_type" : "string", "create_time" : "string", "last_modify_time" : "string" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 edge_app_id 是 String 应用ID 最小长度:4 最大长度:32 edge_app_name 否 String 应用名称 最小长度:4 最大长度:64 description 否 String 应用描述 最小长度:0 最大长度:255 function_type 否 String 功能类型,分为数据处理(DATA_PROCESSING)、协议解析(PROTOCOL_PARSING)、IT集成(ON_PREMISE_INTEGRATION)和混合应用(COMPOSITE_APPLICATION),数据默认为DATA_PROCESSING,数据处理模块可以传输消息,协议解析为驱动类型,IT集成为部署南向3rdIA使用,混合应用可同时实现数据处理和协议解析。 最小长度:0 最大长度:255 枚举值: DATA_PROCESSING PROTOCOL_PARSING ON_PREMISE_INTEGRATION GATEWAY_MANAGER COMPOSITE_APPLICATION DATA_COLLECTION protocol 否 String 驱动协议类型OPCUA|Modbus-TCP 最小长度:0 最大长度:64
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 edge_app_id String 应用id 最小长度:1 最大长度:64 description String 应用描述 最小长度:0 最大长度:256 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 last_published_version String 最新发布版本 最小长度:0 最大长度:64 app_type String 应用类型SYSTEM_REQUIRED|SYSTEM_OPTIONAL|USER 最小长度:0 最大长度:64 function_type String 应用类型DATA_PROCESSING|PROTOCOL_PARSING 最小长度:0 最大长度:64 deploy_type String 部署类型docker|process 最小长度:0 最大长度:64 protocol String 驱动协议类型OPCUA|Modbus-TCP 最小长度:0 最大长度:64 edge_app_name String 应用名称 最小长度:0 最大长度:64
  • 响应示例 状态码: 201 Created { "edge_app_id" : "string", "description" : "string", "create_time" : "string", "update_time" : "string", "last_published_version" : "string", "app_type" : "string", "function_type" : "string", "protocol" : "string", "edge_app_name" : "string", "deploy_type" : "string" }
  • 响应参数 状态码: 200 表14 响应Body参数 参数 参数类型 描述 edge_app_id String 应用ID 最小长度:0 最大长度:32 name String 应用名称 最小长度:0 最大长度:64 version String 应用名称 最小长度:0 最大长度:32 sdk_version String 应用集成的边缘SDK版本 最小长度:1 最大长度:32 description String 应用描述 最小长度:0 最大长度:256 deploy_type String 部署类型docker|process 最小长度:0 最大长度:64 deploy_multi_instance Boolean 是否允许部署多实例 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 state String 应用版本状态 枚举值: DRAFT PUBLISHED OFF_SHELF arch Array of strings 架构 数组长度:1 - 1000000 publish_time String 发布时间 最小长度:0 最大长度:256 off_shelf_time String 下线时间 最小长度:0 最大长度:256
  • 响应示例 状态码: 200 OK { "edge_app_id" : "test-app", "name" : "string", "version" : "1.0.0", "sdk_version" : "string", "description" : "this is a test app", "deploy_type" : "string", "deploy_multi_instance" : false, "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z", "state" : "PUBLISHED", "arch" : [ "string" ], "publish_time" : "2020-05-28T11:31:29.740Z", "off_shelf_time" : "2020-05-28T11:31:29.740Z" }
  • 请求示例 PUT https://{endpoint}/v2/{project_id}/edge-apps/{edge_app_id}/versions/{version} { "description" : "this is a test app version", "deploy_type" : "string", "deploy_multi_instance" : false, "container_settings" : { "configs" : { "privileged" : false, "host_network" : true, "restart_policy" : "string", "container_port_list" : [ { "container_port" : 65535, "host_port" : 65535, "host_ip" : "string" } ] }, "image_url" : "string", "envs" : { }, "volumes" : [ { "name" : "string", "type" : "string", "source" : "string", "destination" : "string", "read_only" : true } ], "resources" : { "limits" : { "cpu" : 1000, "memory" : 1024000, "gpu" : 1024000, "npu" : 1000 }, "requests" : { "cpu" : 1000, "memory" : 1024000, "gpu" : 1024000, "npu" : 1000 } }, "ext_devices" : [ { "source" : "string", "destination" : "string", "cgroup_permissions" : "string" } ] }, "liveness_probe" : { "exec_command" : "string", "tcp_socket" : { "port" : 65535 }, "http_get" : { "path" : "string", "port" : 65535, "host" : "string", "scheme" : "HTTP" }, "initial_delay_seconds" : 3600, "timeout_seconds" : 3600, "period_seconds" : 30, "failure_threshold" : 3 }, "readiness_probe" : { "exec_command" : "string", "tcp_socket" : { "port" : 65535 }, "http_get" : { "path" : "string", "port" : 65535, "host" : "string", "scheme" : "HTTP" }, "initial_delay_seconds" : 3600, "timeout_seconds" : 3600, "period_seconds" : 30, "failure_threshold" : 3 }, "sdk_version" : "string", "arch" : { }, "command" : { }, "args" : { }, "outputs" : { }, "inputs" : { }, "services" : { }, "tpl_id" : "sys_general_opcua" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 应用描述 deploy_type 否 String 部署类型docker|process 最小长度:0 最大长度:64 deploy_multi_instance 否 Boolean 是否允许部署多实例 缺省值:false container_settings 否 ContainerSettingsDTO object 容器相关配置 liveness_probe 否 ProbeDTO object 工作负载存活探针 readiness_probe 否 ProbeDTO object 工作负载业务探针 sdk_version 否 String 应用集成的边缘SDK版本 最小长度:1 最大长度:32 arch 否 Object 架构 command 否 Object 启动命令 args 否 Object 启动参数 outputs 否 Object 应用输出路由端点 inputs 否 Object 应用输入路由 services 否 Object 应用实现的服务列表 tpl_id 否 String 模板id 最小长度:1 最大长度:64 表4 ContainerSettingsDTO 参数 是否必选 参数类型 描述 configs 否 ContainerConfigsDTO object 容器特殊参数 image_url 是 String 镜像存储地址 最小长度:1 最大长度:1000000 envs 否 Object 环境变量 volumes 否 Array of VolumeDTO objects 卷配置 数组长度:0 - 1000000 npu_type 否 String NPU类型 最小长度:0 最大长度:16 枚举值: D310 D910 D310P vnpu_template 否 String NPU算力切分模板,可在对应芯片的机器上通过npu-smi info -t template-info命令查询其详细信息 最小长度:0 最大长度:32 枚举值: vir01 vir02 vir04 vir08 vir02_1c vir04_3c vir04_3c_ndvpp vir04_4c_dvpp resources 否 ResourceDTO object 资源配额 ext_devices 否 Array of ExtDevice objects 外挂设备配置 数组长度:0 - 1000000 表5 ContainerConfigsDTO 参数 是否必选 参数类型 描述 privileged 否 Boolean 开启容器特权模式 缺省值:false host_network 否 Boolean 是否使用主机网络模式 缺省值:true restart_policy 是 String 重启策略,容器执行健康检查后失败后的策略 最小长度:1 最大长度:256 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 VolumeDTO 参数 是否必选 参数类型 描述 name 是 String 卷名称 最小长度:1 最大长度:63 type 否 String 挂载类型 source 是 String 源路径 destination 是 String 卷挂载路径 read_only 否 Boolean 只读,默认只读 表8 ResourceDTO 参数 是否必选 参数类型 描述 limits 否 ResourceConfigDTO object 允许容器使用的最大资源 requests 否 ResourceConfigDTO object 容器需要使用的最小资源 表9 ResourceConfigDTO 参数 是否必选 参数类型 描述 cpu 否 Float cpu个数 最小值:0.01 最大值:1000 memory 否 Float 内存大小 最小值:0.01 最大值:1024000 gpu 否 Float gpu内存大小,单位为M 最小值:0.01 最大值:1024000 npu 否 Float 使用npu加速卡个数 最小值:0.01 最大值:1000 表10 ExtDevice 参数 是否必选 参数类型 描述 source 是 String 源路径 destination 是 String 卷挂载路径 cgroup_permissions 否 String 只读,默认MRW 表11 ProbeDTO 参数 是否必选 参数类型 描述 exec_command 否 String 执行探测的命令行命令 最小长度:0 最大长度:256 tcp_socket 否 TcpSocketDTO object 执行tcp探测 http_get 否 HttpGetDTO object 执行http探测 initial_delay_seconds 是 Integer 表示从工作负载启动后从多久开始探测 最小值:0 最大值:3600 timeout_seconds 是 Integer 表示探测超时时间 最小值:1 最大值:3600 period_seconds 否 Integer 检查周期 最小值:5 最大值:3600 缺省值:30 failure_threshold 否 Integer 失败多少次算不健康 最小值:1 最大值:3600 缺省值:3 表12 TcpSocketDTO 参数 是否必选 参数类型 描述 port 是 Integer 端口 最小值:1 最大值:65535 表13 HttpGetDTO 参数 是否必选 参数类型 描述 path 是 String 请求路径 最小长度:2 最大长度:64 port 是 Integer 端口 最小值:1 最大值:65535 host 否 String 主机地址 最小长度:0 最大长度:64 scheme 是 String 协议类型 最小长度:1 最大长度:64 枚举值: HTTP HTTPS
  • URI PUT /v2/{project_id}/edge-apps/{edge_app_id}/versions/{version} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_app_id 是 String 应用ID,应用唯一。 最小长度:1 最大长度:32 version 是 String 应用版本,应用内版本唯一。 最小长度:1 最大长度:32
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 tpl_id 是 String 模板id 最小长度:1 最大长度:64 name 是 String 模板名称,允许中、数字、英文大小写、下划线、中划线 最小长度:1 最大长度:64 description 是 String 描述 最小长度:0 最大长度:128 config_tabs 是 Object 配置项元数据 default_values 否 Object 默认配置数据
  • 响应示例 状态码: 200 OK { "tpl_id" : "general_app_tpl", "name" : "general_app_tpl", "description" : "通用应用模板", "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" : { "appname" : "LINK" } }
  • 请求示例 POST https://{endpoint}/v2/{project_id}/templates/apps/configs { "tpl_id" : "general_app_tpl", "name" : "general_app_tpl", "description" : "通用应用配置模板", "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" : { "appname" : "LINK" } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 tpl_id String 模板id 最小长度:1 最大长度:64 name String 模板名称 最小长度:1 最大长度:64 description String 描述 最小长度:0 最大长度:128 config_tabs Object 配置项数据 default_values Object 默认数据 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256
共100000条