模块管理-华为云

资源编排服务 RFS-删除私有模块版本:URI

URI DELETE /v1/private-modules/{module_name}/versions/{module_version} 表1 路径参数参数是否必选参数类型描述 module_name 是 String 私有模块（private-module）的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 module_version 是 String 模块的版本号。版本号遵循语义化版本号（Semantic Version），为用户自定义表2 Query参数参数是否必选参数类型描述 module_id 否 String 私有模块（private-module）的唯一Id。此Id由资源编排服务在生成模块的时候生成，为UUID。由于私有模块名称仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的私有模块，删除，再重新创建一个同名私有模块。对于团队并行开发，用户可能希望确保，当前我操作的私有模块就是我认为的那个，而不是其他队友删除后创建的同名私有模块。因此，使用Id就可以做到强匹配。资源编排服务保证每次创建的私有模块所对应的Id都不相同，更新不会影响Id。如果给予的module_id和当前模块的Id不一致，则返回400

资源编排服务 RFS 资源编排-模块管理

资源编排服务 RFS-删除私有模块版本:响应参数

响应参数状态码：400 表4 响应Body参数参数参数类型描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。表5 Detail 参数参数类型描述 error_code String 响应码 error_msg String 响应消息状态码：401 表6 响应Body参数参数参数类型描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。表7 Detail 参数参数类型描述 error_code String 响应码 error_msg String 响应消息状态码：403 表8 响应Body参数参数参数类型描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。表9 Detail 参数参数类型描述 error_code String 响应码 error_msg String 响应消息状态码：404 表10 响应Body参数参数参数类型描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。表11 Detail 参数参数类型描述 error_code String 响应码 error_msg String 响应消息状态码：429 表12 响应Body参数参数参数类型描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。表13 Detail 参数参数类型描述 error_code String 响应码 error_msg String 响应消息状态码：500 表14 响应Body参数参数参数类型描述 error_code String 响应码 error_msg String 响应消息 encoded_authorization_message String 包含有关未经授权请求的信息。 details Array of Detail objects 权限拒绝时服务返回的详细错误信息。表15 Detail 参数参数类型描述 error_code String 响应码 error_msg String 响应消息

资源编排服务 RFS 资源编排-模块管理

需求管理 CODEARTS REQ-创建模块:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 status String 请求状态 message String 请求失败信息 result ModuleEntity object 模块详情表4 ModuleEntity 参数参数类型描述 id String 模块id sequence String 模块顺序值。double类型 level Integer 模块层级，最多3层 description String 模块描述信息 created_by String 模块创建人id created_time String 模块创建时间 modified_by String 模块最近修改人id modified_time String 模块最近修改时间 display_value String 模块显示名 path_name String 子模块的路径名 value String 模块唯一标识，自定义模块value和id项目 parent_id String 父模块id child_modules Array of ModuleEntity objects 子模块 assignee String 模块责任人id

需求管理 CODEARTS REQ IPD模块管理

需求管理 CODEARTS REQ-创建模块:请求示例

请求示例创建子模块 {endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/modules { "description" : "11111222", "display_value" : "API-M2-P-01", "parent_id" : 1030206424665337900, "assignee" : "a360371833bf4c558f796fd707b44daf" }

需求管理 CODEARTS REQ IPD模块管理

需求管理 CODEARTS REQ-创建模块:响应示例

响应示例状态码： 200 OK { "status" : "success", "message" : null, "result" : { "id" : "1030874468408406016", "created_by" : "a360371833bf4c558f796fd707b44daf", "value" : "1030874468408406016" } }

需求管理 CODEARTS REQ IPD模块管理

IoT边缘 IoTEdge-创建边缘模块:响应示例

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

IoT边缘 IoTEdge 模块管理

IoT边缘 IoTEdge-创建边缘模块:请求示例

请求示例 POST https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/modules{ "edge_app_id" : "test-app", "app_version" : "1.0.0", "module_name" : "edge_module", "container_settings" : { "configs" : { "container_port_list" : [ { "container_port" : 65535, "host_port" : 65535, "host_ip" : "string" } ] } }}

IoT边缘 IoTEdge 模块管理

IoT边缘 IoTEdge-创建边缘模块:请求参数

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

IoT边缘 IoTEdge 模块管理

IoT边缘 IoTEdge-创建边缘模块:响应参数

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

IoT边缘 IoTEdge 模块管理

云服务器内容精选

模块管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线