华为云用户手册

响应示例 状态码： 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "apps" : [ { "app_id" : "string", "description" : "string", "app_type" : "string", "provider_type" : "string", "create_time" : "string", "update_time" : "string" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 apps Array of QueryAppBriefResponseDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 QueryAppBriefResponseDTO 参数 参数类型 描述 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 /v3/{project_id}/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app_type 否 String 应用类型 最小长度：1 最大长度：64 provider_type 否 String 应用来源 最小长度：1 最大长度：64 app_id 否 String 应用ID 最小长度：1 最大长度：32 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000。 最小值：1 最大值：1000 缺省值：10 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0。 最小值：0 最大值：1000000 缺省值：0

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

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

请求示例 PUT https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/modules/{module_id}/shadow: { "properties" : { "connect_info" : { "endpoint" : "string", "user_name" : "string", "password" : "string" }, "channels" : [ { "device_id" : "string", "peer_session_name" : "string", "pin_code" : "string", "role_type" : "string" } ] } }

URI PUT /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 OK { "name" : "string", "internal_ip" : "string", "hostname" : "string", "allocatable" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "capacity" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "allocated_resources" : { "request" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "limit" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 } }, "status" : "Ready", "architecture" : "string", "labels" : { }, "node_type" : "string", "kernel_version" : "string", "os_image" : "string", "container_runtime_version" : "string", "kubernetes_version" : "string", "create_time" : "string" }

URI GET /v3/{project_id}/clusters/{cluster_id}/nodes/{node_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 cluster_id 是 String 边缘集群ID 最小长度：1 最大长度：64 node_name 是 String 节点名称 最小长度：1 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 nas Array of QueryNaBriefResponseDTO objects 北向NA列表 数组长度：0 - 100 表5 QueryNaBriefResponseDTO 参数 参数类型 描述 na_id String NA系统ID，提供给其他系统访问的唯一标识 最小长度：1 最大长度：32 name String NA系统名称 最小长度：1 最大长度：64 description String 北向NA系统描述 最小长度：0 最大长度：255 endpoint String 访问URL地址 最小长度：1 最大长度：512 create_time String 创建时间 最小长度：0 最大长度：256 update_time String 更新时间 最小长度：0 最大长度：256

响应示例 状态码： 200 OK { "nas" : [ { "na_id" : "na_id_1", "name" : "北向NA系统1", "description" : "这是一个北向NA", "endpoint" : "https://068b72f3b75444dda67cc6e2286a4c20.apic.cn-south-1.huaweicloudapis.com", "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z" } ] }

URI GET /v2/{project_id}/nas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String NA名称搜索关键字 最小长度：1 最大长度：64 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：0 缺省值：0 limit 否 Integer 每页记录数，取值范围为非负整数，默认值为10 最小值：10 最大值：10 缺省值：10

URI DELETE /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

响应示例 状态码： 201 Created { "id" : "string", "namespace" : "string", "version" : "string", "app_id" : "string", "app_version" : "string", "status" : "string", "status_description" : "string", "values" : { }, "create_time" : "string", "update_time" : "string" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 应用实例ID 最小长度：1 最大长度：24 namespace 否 String 边缘集群命名空间 最小长度：1 最大长度：63 app_id 是 String 应用ID 最小长度：1 最大长度：32 app_version 是 String 应用版本 最小长度：1 最大长度：32 values 否 Object 应用实例chart配置

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 id String 应用实例ID namespace String 边缘集群命名空间 version String 应用实例版本 app_id String 应用ID app_version String 应用版本 status String 应用实例状态 status_description String 状态描述 values Object 应用实例chart配置 create_time String 创建时间 update_time String 最后一次更新时间

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

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