模块管理-华为云

IOT边缘 IOTEDGE-修改边缘模块:请求示例

请求示例 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" }

IOT边缘 IOTEDGE 模块管理

IOT边缘 IOTEDGE-修改边缘模块:响应示例

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

IOT边缘 IOTEDGE 模块管理

IOT边缘 IOTEDGE-修改边缘模块:响应参数

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

IOT边缘 IOTEDGE 模块管理

IOT边缘 IOTEDGE-修改边缘模块:请求参数

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

IOT边缘 IOTEDGE 模块管理

IOT边缘 IOTEDGE-修改边缘模块:URI

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

IOT边缘 IOTEDGE 模块管理

IOT边缘 IOTEDGE-修改边缘模块状态:响应示例

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

IOT边缘 IOTEDGE 模块管理

IOT边缘 IOTEDGE-修改边缘模块状态:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。最小长度：0 最大长度：20000 表3 请求Body参数参数是否必选参数类型描述 state 否 String 模块状态枚举值： RUNNING STOPPED

IOT边缘 IOTEDGE 模块管理

IOT边缘 IOTEDGE-修改边缘模块状态:URI

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

IOT边缘 IOTEDGE 模块管理

IOT边缘 IOTEDGE-修改边缘模块状态:响应参数

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

IOT边缘 IOTEDGE 模块管理

云服务器内容精选

模块管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线