华为云用户手册

URI DELETE /v2/{project_id}/edge-nodes/{node_id}/ias/{ia_id}/api 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 ia_id 是 String 第三方应用IA ID 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 ia_uri 是 String 第三方IA服务资源地址 最小长度：1 最大长度：128

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表4 请求Body参数 参数 是否必选 参数类型 描述 body 否 Object 第三方IA服务资源请求结构体

响应示例 状态码： 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "datasources" : [ { "ds_id" : "opcua_1", "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" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 datasources Array of QueryDcDsBriefRespDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 QueryDcDsBriefRespDTO 参数 参数类型 描述 ds_id String 采集数据源id，节点下唯一 最小长度：1 最大长度：64 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 缺省值：false edge_app_name String 应用ID 最小长度：0 最大长度：64 connection_info Object 数采连接信息 module_state String 数采连接状态,RUNNING|STOPPED 最小长度：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

URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 module_id 否 String 数据源所属的模块id 最小长度：1 最大长度：64 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000 最小值：0 最大值：1000000 缺省值：10

请求示例 POST https://{endpoint}/v2/{project_id}/edge-apps/{edge_app_id}/versions { "version" : "1.0.0", "description" : "string", "sdk_version" : "string", "deploy_type" : "docker", "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 } ], "npu_type" : "D310", "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 }, "arch" : { }, "command" : { }, "args" : { }, "outputs" : { }, "inputs" : { }, "services" : { }, "supplier" : "华为", "tpl_id" : "sys_general_opcua" }

响应示例 状态码： 201 Created { "edge_app_id" : "string", "name" : "string", "deploy_type" : "string", "deploy_multi_instance" : false, "version" : "string", "sdk_version" : "string", "description" : "string", "create_time" : "string", "update_time" : "string", "state" : "DRAFT", "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 }, "arch" : "string", "command" : "string", "args" : "string", "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" } }, "outputs" : "string", "inputs" : "string", "services" : "string", "publish_time" : { }, "off_shelf_time" : { }, "supplier" : "华为", "tpl_id" : "sys_general_opcua" }

响应参数 状态码： 201 表14 响应Body参数 参数 参数类型 描述 edge_app_id String 应用ID 最小长度：0 最大长度：32 name String 应用名称 最小长度：0 最大长度：64 deploy_type String 部署类型docker|process 最小长度：0 最大长度：64 deploy_multi_instance Boolean 是否允许部署多实例 缺省值：false version String 应用版本 最小长度：0 最大长度：32 sdk_version String 应用集成的边缘SDK版本 最小长度：1 最大长度：32 description String 应用描述 最小长度：0 最大长度：256 create_time String 创建时间 最小长度：0 最大长度：256 update_time String 最后一次修改时间 最小长度：0 最大长度：256 state String 应用版本状态 最小长度：0 最大长度：64 枚举值： DRAFT PUBLISHED OFF_SHELF liveness_probe ProbeDTO object 工作负载存活探针 readiness_probe ProbeDTO object 工作负载业务探针 arch Array of strings 架构 数组长度：1 - 1000000 command Array of strings 启动命令 数组长度：1 - 1000000 args Array of strings 启动参数 数组长度：1 - 1000000 container_settings ContainerSettingsDTO object 容器相关配置 outputs Array of strings 应用输出路由端点 数组长度：1 - 1000000 inputs Array of strings 应用输入路由 数组长度：1 - 1000000 services Array of strings 应用实现的服务列表 数组长度：1 - 1000 publish_time String 发布时间 最小长度：0 最大长度：256 off_shelf_time String 下线时间 最小长度：0 最大长度：256 supplier String 驱动厂商 最小长度：1 最大长度：128 tpl_id String 模板id 最小长度：1 最大长度：64 表15 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 表16 TcpSocketDTO 参数 参数类型 描述 port Integer 端口 最小值：1 最大值：65535 表17 HttpGetDTO 参数 参数类型 描述 path String 请求路径 最小长度：2 最大长度：64 port Integer 端口 最小值：1 最大值：65535 host String 主机地址 最小长度：0 最大长度：64 scheme String 协议类型 最小长度：1 最大长度：64 枚举值： HTTP HTTPS 表18 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 表19 ContainerConfigsDTO 参数 参数类型 描述 privileged Boolean 开启容器特权模式 缺省值：false host_network Boolean 是否使用主机网络模式 缺省值：true restart_policy String 重启策略，容器执行健康检查后失败后的策略 最小长度：1 最大长度：256 container_port_list Array of ContainerPortDTO objects 容器端口映射值 数组长度：0 - 1000000 表20 ContainerPortDTO 参数 参数类型 描述 container_port Integer 构成一堆映射的容器端口 最小值：1 最大值：65535 host_port Integer 构成一对映射的物理机对应网卡端口 最小值：1 最大值：65535 host_ip String 对应网卡地址 最小长度：0 最大长度：64 表21 VolumeDTO 参数 参数类型 描述 name String 卷名称 最小长度：1 最大长度：63 type String 挂载类型 source String 源路径 destination String 卷挂载路径 read_only Boolean 只读，默认只读 表22 ResourceDTO 参数 参数类型 描述 limits ResourceConfigDTO object 允许容器使用的最大资源 requests ResourceConfigDTO object 容器需要使用的最小资源 表23 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 表24 ExtDevice 参数 参数类型 描述 source String 源路径 destination String 卷挂载路径 cgroup_permissions String 只读，默认MRW

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 version 是 String 应用版本 最小长度：1 最大长度：32 description 否 String 应用描述 最小长度：0 最大长度：255 sdk_version 否 String 应用集成的边缘SDK版本 最小长度：1 最大长度：32 deploy_type 否 String 应用部署类型，分为docker容器部署类型和process进程部署类型，兼容之前数据，此字段可以为空，为空情况为docker类型 最小长度：0 最大长度：64 枚举值： docker process deploy_multi_instance 否 Boolean 是否允许部署多实例 缺省值：false container_settings 是 ContainerSettingsDTO object 容器相关配置 liveness_probe 否 ProbeDTO object 工作负载存活探针 readiness_probe 否 ProbeDTO object 工作负载业务探针 arch 是 Object 架构 command 否 Object 启动命令 args 否 Object 启动参数 outputs 否 Object 应用输出路由端点 inputs 否 Object 应用输入路由 services 否 Object 应用实现的服务列表 supplier 否 String 驱动厂商 最小长度：1 最大长度：128 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

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表4 请求Body参数 参数 是否必选 参数类型 描述 body 否 Object 第三方IA服务资源请求结构体

URI PUT /v2/{project_id}/edge-nodes/{node_id}/ias/{ia_id}/api 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 ia_id 是 String 第三方应用IA ID 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 ia_uri 是 String 第三方IA服务资源地址 最小长度：1 最大长度：128

请求示例 GET https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id} { "config" : { "connection_info" : { "endpoint" : "opc.tcp://127.0.0.1:53530/OPCUA", "username" : "admin", "password" : "*****" }, "collection_paras" : { "default_cycle" : 1000 } }, "name" : "电力子系统", "quality_report" : false }

响应示例 状态码： 200 修改数据源配置数据 { "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参数 参数 是否必选 参数类型 描述 config 否 Object 数据源的连接及采集信息 name 否 String 采集数据源名称，允许中、数字、英文大小写、下划线、中划线 最小长度：1 最大长度：64 quality_report 否 Boolean 质量上报开关，不携带或值不为true，默认为false

URI PUT /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 表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

URI POST /v2/{project_id}/nas/{na_id}/nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 na_id 是 String 北向数据接收端点ID 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 action 是 String 批量删除delete，批量添加add 最小长度：1 最大长度：64

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 nodes Array of QueryAuthorizedNodeDTO objects 授权北向NA信息到边缘节点列表的返回结构体，仅返回本次授权的节点列表信息 表6 QueryAuthorizedNodeDTO 参数 参数类型 描述 node_id String 边缘节点ID 最小长度：1 最大长度：64 authorized_time String 授权时间 最小长度：1 最大长度：64

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表4 请求Body参数 参数 是否必选 参数类型 描述 node_ids 是 Object 授权北向NA信息到边缘节点的请求结构体

请求示例 PUT https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/externals/{external_id} { "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 } }

URI PUT /v2/{project_id}/edge-nodes/{edge_node_id}/externals/{external_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 external_id 是 String 外部实体ID 最小长度：1 最大长度：64

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

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

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

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

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 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