华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 log_configs Array of LogConfigDTO objects 边缘节点在IEF的日志配置 数组长度：0 - 10 ha_config HaConfigDTO object 节点根目录配置 edge_node_id String 边缘节点Id 最小长度：1 最大长度：64 instance_id String 实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。 最小长度：1 最大长度：36 product_id String 边缘节点关联的产品ID，用于唯一标识一个产品模型。 最小长度：1 最大长度：36 product_name String 边缘节点关联的产品名称。 最小长度：1 最大长度：64 space_id String 资源空间id，对应IOTDA云服务接口参数中的app_id。 最小长度：1 最大长度：64 resource_spec_types Array of strings 节点所购买的资源类型的列表 最小长度：4 最大长度：16 resource_ids Array of strings 资源id列表，创建节点时需绑定已购买的资源包，可以叠加节点功能。 最小长度：1 最大长度：64 ips Array of strings 边缘节点主机ip 数组长度：0 - 10 name String 边缘节点名称 最小长度：1 最大长度：64 state String 边缘节点状态 最小长度：4 最大长度：32 software_version String 边缘应用id，只允许数字、英文小写、中划线，切必须以字母或数字结尾 最小长度：0 最大长度：32 create_time String 边缘节点创建时间 最小长度：0 最大长度：256 update_time String 边缘节点更新时间 最小长度：0 最大长度：256 os_name String 边缘节点操作系统名称 最小长度：1 最大长度：64 arch String 边缘节点操作系统架构 最小长度：4 最大长度：16 host_name String 边缘节点主机名 最小长度：1 最大长度：256 nics Array of Nic objects 边缘节点网络网卡信息 数组长度：0 - 10 specification String 网络规格，如4 cores | 3867 MB 最小长度：0 最大长度：64 ai_card_type String AI加速卡类型，如华为昇腾AI加速卡NPU、图像处理加速卡GPU。 最小长度：0 最大长度：16 npu_library_path String npu驱动动态库路径 最小长度：0 最大长度：256 container_version String 容器运行时版本 最小长度：0 最大长度：64 type String 节点所属资源类型：advanced|standard 最小长度：4 最大长度：16 security_level String 节点的安全等级，MEDIUM边缘节数据上报不进行加密，HIGH对数据上报进行加密。 最小长度：1 最大长度：64 reliability_level String 节点的可靠性等级。 缺省值：LOW 最小长度：1 最大长度：64 storage_period Integer 节点的存储周期，默认0天，取值范围0~7天，0天则不存储。 最小值：0 最大值：7 base_path BasePathDTO object 节点根目录配置 hardware_model String 注册节点网关配置 最小长度：0 最大长度：1024 offline_cache_configs OfflineCacheConfigsDTO object 边缘节点离线缓存配置 device_auth_info DeviceAuthInfoDisplayDTO object 边缘节点设备认证方式 device_data_format String 节点使用的数据格式，默认为iotda物模型1.0格式，可以选择属性平铺数据格式flat_json 最小长度：0 最大长度：16 automatic_upgrade String 自动升级系统应用的节点开关，默认为关闭：OFF，IMMEDIATE表示节点开关打开 最小长度：0 最大长度：16 device_data_record DeviceDataRecord object 边缘节点设备数据上报打印配置 metric_report String omagent监控运维工具是否上报指标 最小长度：0 最大长度：16 iotda_south_access String iotda南向接入地址 最小长度：0 最大长度：128 表4 LogConfigDTO 参数 参数类型 描述 size Integer 应用日志文件大小限制，单位MB，默认50，取值范围10-1000 最小值：10 最大值：1000 level String 应用日志级别，可选项：on/off/trace/debug/info/warn/error/fatal，当type为LTS时有效。当选择非on/off的选项时，将只采集大于等于指定级别的日志。 rotate_num Integer 应用日志rotate个数，默认5，取值范围1-10 最小值：1 最大值：10 rotate_period String 应用日志rotate周期，可选项： daily/monthly/weekly/yearly type String LTS:将日志发送到LTS, local 本地日志 缺省值：LTS component String app:部署到边缘设备上的应用的日志, system 边缘设备上系统的日志 表5 HaConfigDTO 参数 参数类型 描述 ha_type String 节点高可用类型双活或者主备 缺省值：ACTIVE_STANDBY active_standby_config ActiveStandbyConfigDTO object 主备详细配置 表6 ActiveStandbyConfigDTO 参数 参数类型 描述 work_node String 当前的工作节点，主节点还是备节点在工作，初始创建时工作节点为DEFAULT节点，(DEFAULT|MASTER|SLAVE) 缺省值：DEFAULT 最小长度：1 最大长度：64 master_interface_name String 主节点网卡名称 最小长度：1 最大长度：64 slave_interface_name String 备节点网卡名称 最小长度：1 最大长度：64 virtual_ip_address String 网卡ip 最小长度：0 最大长度：64 virtual_ipv6_address String 网卡ipv6地址 最小长度：0 最大长度：64 表7 Nic 参数 参数类型 描述 eth String 网卡信息，如eth0,eth1 最小长度：0 最大长度：32 ip String 网卡ip 最小长度：0 最大长度：64 mask_len Integer 子网掩码的位数 最小值：0 最大值：32 表8 BasePathDTO 参数 参数类型 描述 log_base_path String 节点日志根目录 最小长度：1 最大长度：64 config_base_path String 节点配置根目录 最小长度：1 最大长度：64 db_base_path String 节点数据存储根目录 最小长度：1 最大长度：64 表9 OfflineCacheConfigsDTO 参数 参数类型 描述 publish_order String 数据上报优先级，可选项：realtime_first实时数据优先 sequential按时序上报，默认realtime_first 缺省值：realtime_first period Integer 节点离线缓存数据的储存天数，默认7，取值范围-1~14，-1表示存储天数没有限制 最小值：-1 最大值：14 缺省值：7 capacity Integer 节点离线缓存容量，单位MB，默认2048，取值范围500-8192 最小值：500 最大值：8192 缺省值：2048 表10 DeviceAuthInfoDisplayDTO 参数 参数类型 描述 auth_type String 边缘节点认证方式。 缺省值：SECRET local_path CertificateLocalPathDTO object 证书文件的本地存储路径 表11 CertificateLocalPathDTO 参数 参数类型 描述 cert_path String 节点数字证书的本地存储路径。 最小长度：1 最大长度：2048 key_path String 证书私钥的本地存储路径。 最小长度：1 最大长度：2048 表12 DeviceDataRecord 参数 参数类型 描述 disk_quota Integer 磁盘配额，单位MB，参考值，只能保证在这个值左右 最小值：512 最大值：10240 缺省值：512 age Integer 老化时间，日志压缩文件名时间戳老于这个时间就会发生老化删除 最小值：1 最大值：7 缺省值：1 state String 配置开关，true启用数据打印，false不启用数据打印 最小长度：0 最大长度：16

响应示例 状态码： 200 OK { "devices" : [ { "device_id" : "string", "node_id" : "string", "gateway_id" : "string", "device_name" : "string", "protocol_type" : "string", "product_name" : "string", "product_id" : "string" } ], "count" : "0,", "page_info" : { "offset" : 1000000, "limit" : 1000 } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 devices Array of QueryDeviceSimplifyDto objects 查询设备列表响应结构体 数组长度：0 - 1000000 count Long 满足查询条件的记录总数。 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 表5 QueryDeviceSimplifyDto 参数 参数类型 描述 device_id String 设备id 最小长度：0 最大长度：256 node_id String 设备识别码 最小长度：0 最大长度：64 gateway_id String 父设备id 最小长度：0 最大长度：256 device_name String 设备名称 最小长度：0 最大长度：256 protocol_type String 设备协议类型 最小长度：0 最大长度：20 product_name String 产品名称 最小长度：0 最大长度：255 product_id String 产品ID 最小长度：0 最大长度：255 表6 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000

URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度：1 最大长度：64 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 gateway_id 否 String 父设备ID,对应之前的gatewayId的概念，传该参数时代表查询网关下的子设备，不传代表节点下的 最小长度：0 最大长度：256 device_name 否 String 设备名称 最小长度：0 最大长度：256 module_id 否 String 设备所属的模块id 最小长度：1 最大长度：64 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 分页信息 devices Array of QueryDcDeviceRespDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 QueryDcDeviceRespDTO 参数 参数类型 描述 device_id String 设备id

URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度：1 最大长度：64 ds_id 是 String 采集数据源id，创建数据源配置时设置，节点下唯一。 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 device_id 否 String 设备标识码。 最小长度：1 最大长度：128 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000 最小值：0 最大值：1000000 缺省值：10

URI GET /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 表3 响应Body参数 参数 参数类型 描述 id String 配置ID 最小长度：1 最大长度：32 name String 配置项名称 最小长度：1 最大长度：64 value String 配置项详情 最小长度：1 最大长度：2048 description String 配置项描述 最小长度：0 最大长度：255 version Long 版本号 最小长度：0 最大长度：64 state String 下发状态 枚举值： SUCCESS SENDING create_time String 创建时间 最小长度：0 最大长度：256 update_time String 更新时间 最小长度：0 最大长度：256

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

响应参数 状态码： 200 表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 最后一次更新时间

请求示例 PUT https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/app-instances/{app_instance_id} { "action" : "string", "namespace" : "string", "app_version" : "string", "values" : { }, "rollback_version" : "string" }

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

URI PUT /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 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 动作类型 namespace 否 String 命名空间，应用实例部署于非默认命名空间(default)时必填 最小长度：1 最大长度：63 app_version 否 String 升级的目标版本号，动作类型为upgrade时必填 最小长度：1 最大长度：32 values 否 Object 应用实例chart配置，动作类型为upgrade时必填 rollback_version 否 String 回退的目标版本号，动作类型为rollback时必填 最小长度：1 最大长度：32

响应示例 状态码： 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "app_versions" : [ { "app_id" : "string", "version" : "string", "values" : { }, "create_time" : "string", "update_time" : "string" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值：0 最大值：1000000 page_info PageInfoDTO object 分页信息 app_versions Array of QueryAppVersionResponseDTO objects 每页记录数 数组长度：0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值：0 最大值：1000000 limit Integer 每页记录数 最小值：1 最大值：1000 表6 QueryAppVersionResponseDTO 参数 参数类型 描述 app_id String 应用模板ID version String 应用版本 values Object 应用版本配置 create_time String 创建时间 update_time String 最后一次修改时间

URI GET /v3/{project_id}/apps/{app_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 app_id 是 String 应用ID 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 version 否 String 应用版本号 最小长度：1 最大长度：32 limit 否 Integer 每页记录数，默认值为10，取值区间为1-1000。 最小值：1 最大值：1000 缺省值：10 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0。 最小值：0 最大值：1000000 缺省值：0

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

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度：0 最大长度：20000 表3 请求Body参数 参数 是否必选 参数类型 描述 external_id 是 String 外部实体Id，节点下唯一 最小长度：1 最大长度：64 protocol 是 String 连接外部实体的协议类型 connection_type 是 String 连接类型 mqtt_connection_info 否 MqttConnectionInfo object mqtt连接信息 space_id 否 String 资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的外部实体归属到IoDA哪个资源空间下的边缘节点设备下，否则创建的外部实体将会归属到默认资源空间下对应的边缘节点下,对应于IoDA的app_id. 最小长度：1 最大长度：36 表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

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

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

响应参数 状态码： 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 下发状态 枚举值： SUCCESS SENDING create_time String 创建时间 最小长度：0 最大长度：256 update_time String 更新时间 最小长度：0 最大长度：256

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

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 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" } ] }

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