华为云用户手册

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 points Array of CreateDcPointRespDTO objects 每页记录数 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 CreateDcPointRespDTO 参数 参数类型 描述 point_id String 点位表id,数据源下唯一 最小长度:1 最大长度:64 name String 点位名称,允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符 最小长度:1 最大长度:64 collection_config Object 点位采集配置 device_id String 设备id property String 属性,允许中、数字、英文大小写、下划线、中划线 最小长度:1 最大长度:128 data_type String 点位数据类型 最小长度:1 最大长度:32 ds_id String 采集数据源id,节点下唯一 最小长度:1 最大长度:64 processing_config ProcessingConfigDTO object 点位处理配置 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 表7 ProcessingConfigDTO 参数 参数类型 描述 validity PointValidityingDTO object 点位校验 stream_formula String 点位流公式配置字段 最小长度:0 最大长度:128 scaling PointScalingDTO object 点位缩放规则列表 clean PointCleanDTO object 点位计算规则列表 表8 PointValidityingDTO 参数 参数类型 描述 min Object 点位上报值的最小值,小于该值则上报告警 max Object 点位上报值的最大值,大于该值则上报告警 outlier_filtering Boolean 异常值过滤 表9 PointScalingDTO 参数 参数类型 描述 ratio Double 缩放的倍率 最小值:-10000 最大值:10000 base Double 基准值 最小值:-10000 最大值:10000 accuracy Integer 缩放后结果的精度,精确到小数点后几位,-1表示全部保留,0表示只保留整数位 最小值:-1 最大值:8 缺省值:-1 表10 PointCleanDTO 参数 参数类型 描述 silent_window Integer 静默时间窗口,在该时间窗口内,没有触发上报条件,点位将不会上 最小值:0 最大值:86400 deviation Double 偏差,在该偏差范围内表示是正常波动,点位将不进行上报 最小值:0 最大值:100
  • 响应示例 状态码: 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "points" : [ { "point_id" : "MotorVoltage", "name" : "马达电压", "collection_config" : { "address" : "ns=2;s=Root/Motor/Voltage", "data_type" : "int", "cycle" : 10000 }, "device_id" : "MotorVoltage", "property" : "Motor/Voltage", "data_type" : "int", "ds_id" : "opcua_1", "processing_config" : { "validity" : { "min" : 60, "max" : 100 }, "stream_formula" : "bit(0).bool()|string_to_double(-1.0)|string_to_int(0)", "scaling" : { "ratio" : 1, "base" : 100, "accuracy" : 2 }, "clean" : { "silent_window" : 60, "deviation" : 0.1 } }, "create_time" : "2020-05-28T11:31:29.740Z", "update_time" : "2020-05-28T11:31:29.740Z" } ] }
  • URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/points 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 ds_id 是 String 采集数据源id,创建数据源配置时设置,节点下唯一。 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 point_id 否 String 采集点位表id,创建点位表时设置,数据源下唯一。 最小长度:1 最大长度:64 name 否 String 点位名称,允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符.模糊查询 最小长度:1 最大长度:64 property 否 String 属性,允许中、数字、英文大小写、下划线、中划线,精确查询 最小长度:1 最大长度:128 device_id 否 String 设备标识,精确查询 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:1000000 缺省值:0 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000 最小值:0 最大值:1000000 缺省值:10
  • 请求示例 PUT https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/points/{point_id} { "name" : "马达电压", "collection_config" : { "address" : "ns=2;s=Root/Motor/Voltage", "data_type" : "int", "cycle" : 10000 }, "device_id" : "MotorVoltage", "property" : "Motor/Voltage", "data_type" : "int", "processing_config" : { "validity" : { "min" : 60, "max" : 100 }, "stream_formula" : "bit(0).bool()|string_to_double(-1.0)|string_to_int(0)", "scaling" : { "ratio" : 1, "base" : 100, "accuracy" : 2 }, "clean" : { "silent_window" : 60, "deviation" : 0.1 } } }
  • 响应示例 状态码: 200 OK { "point_id" : "MotorVoltage", "name" : "马达电压", "collection_config" : { "address" : "ns=2;s=Root/Motor/Voltage", "data_type" : "int", "cycle" : 10000 }, "device_id" : "MotorVoltage", "property" : "Motor/Voltage", "data_type" : "int", "ds_id" : "opcua_1", "processing_config" : { "validity" : { "min" : 60, "max" : 100 }, "stream_formula" : "bit(0).bool()|string_to_double(-1.0)|string_to_int(0)", "scaling" : { "ratio" : 1, "base" : 100, "accuracy" : 2 }, "clean" : { "silent_window" : 60, "deviation" : 0.1 } }, "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认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 点位名称,允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符 最小长度:1 最大长度:64 collection_config 否 Object 点位采集配置 device_id 是 String 设备id property 是 String 属性,允许中、数字、英文大小写、下划线、中划线 最小长度:0 最大长度:128 data_type 否 String 点位数据类型 最小长度:1 最大长度:32 processing_config 否 ProcessingConfigDTO object 点位处理配置 表4 ProcessingConfigDTO 参数 是否必选 参数类型 描述 validity 否 PointValidityingDTO object 点位校验 stream_formula 否 String 点位流公式配置字段 最小长度:0 最大长度:128 scaling 否 PointScalingDTO object 点位缩放规则列表 clean 否 PointCleanDTO object 点位计算规则列表 表5 PointValidityingDTO 参数 是否必选 参数类型 描述 min 是 Object 点位上报值的最小值,小于该值则上报告警 max 是 Object 点位上报值的最大值,大于该值则上报告警 outlier_filtering 否 Boolean 异常值过滤 表6 PointScalingDTO 参数 是否必选 参数类型 描述 ratio 是 Double 缩放的倍率 最小值:-10000 最大值:10000 base 是 Double 基准值 最小值:-10000 最大值:10000 accuracy 否 Integer 缩放后结果的精度,精确到小数点后几位,-1表示全部保留,0表示只保留整数位 最小值:-1 最大值:8 缺省值:-1 表7 PointCleanDTO 参数 是否必选 参数类型 描述 silent_window 是 Integer 静默时间窗口,在该时间窗口内,没有触发上报条件,点位将不会上 最小值:0 最大值:86400 deviation 是 Double 偏差,在该偏差范围内表示是正常波动,点位将不进行上报 最小值:0 最大值:100
  • 响应参数 状态码: 200 表8 响应Body参数 参数 参数类型 描述 point_id String 点位表id,数据源下唯一 最小长度:1 最大长度:64 name String 点位名称,允许中、数字、英文大小写、下划线、中划线、#%()*特殊字符 最小长度:1 最大长度:64 collection_config Object 点位采集配置 device_id String 设备id property String 属性,允许中、数字、英文大小写、下划线、中划线 最小长度:1 最大长度:128 data_type String 点位数据类型 最小长度:1 最大长度:32 ds_id String 采集数据源id,节点下唯一 最小长度:1 最大长度:64 processing_config ProcessingConfigDTO object 点位处理配置 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 表9 ProcessingConfigDTO 参数 参数类型 描述 validity PointValidityingDTO object 点位校验 stream_formula String 点位流公式配置字段 最小长度:0 最大长度:128 scaling PointScalingDTO object 点位缩放规则列表 clean PointCleanDTO object 点位计算规则列表 表10 PointValidityingDTO 参数 参数类型 描述 min Object 点位上报值的最小值,小于该值则上报告警 max Object 点位上报值的最大值,大于该值则上报告警 outlier_filtering Boolean 异常值过滤 表11 PointScalingDTO 参数 参数类型 描述 ratio Double 缩放的倍率 最小值:-10000 最大值:10000 base Double 基准值 最小值:-10000 最大值:10000 accuracy Integer 缩放后结果的精度,精确到小数点后几位,-1表示全部保留,0表示只保留整数位 最小值:-1 最大值:8 缺省值:-1 表12 PointCleanDTO 参数 参数类型 描述 silent_window Integer 静默时间窗口,在该时间窗口内,没有触发上报条件,点位将不会上 最小值:0 最大值:86400 deviation Double 偏差,在该偏差范围内表示是正常波动,点位将不进行上报 最小值:0 最大值:100
  • URI PUT /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/points/{point_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 ds_id 是 String 采集数据源id,创建数据源配置时设置,节点下唯一。 最小长度:1 最大长度:64 point_id 是 String 采集点位表id,创建点位表时设置,数据源下唯一。 最小长度:1 最大长度:64
  • URI POST /v2/{project_id}/edge-nodes/{edge_node_id}/install 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 arch 是 String 节点架构 最小长度:4 最大长度:16
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表4 请求Body参数 参数 是否必选 参数类型 描述 host_tag 否 String 安装命令执行的主机标签DEFAULT|MASTER|SLAVE 最小长度:4 最大长度:64
  • 响应示例 状态码: 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "app_images" : [ { "image_namespace" : "iot", "name" : "edge_manager", "tag" : "1.0.0", "digest" : "sha256:38f3f34301cec3cabd9de3f65f2b313ed7e44d6b211254e7156d12229c5b459f", "create_time" : "string" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 app_images Array of QueryAppImageResponseDTO objects 每页记录数 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryAppImageResponseDTO 参数 参数类型 描述 image_namespace String 镜像组织 name String 镜像仓库名称 tag String 镜像tag digest String 镜像摘要 create_time String 创建时间
  • URI GET /v3/{project_id}/apps/{app_id}/versions/{version}/images 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 app_id 是 String 应用ID 最小长度:1 最大长度:32 version 是 String 应用版本 最小长度:1 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000。 最小值:1 最大值:1000 缺省值:10 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0。 最小值:0 最大值:1000000 缺省值:0
  • 响应示例 状态码: 200 OK { "edge_app_id" : "string", "description" : "string", "create_time" : "string", "update_time" : "string", "last_published_version" : "string", "app_type" : "string", "function_type" : "string", "protocol" : "string", "edge_app_name" : "string", "deploy_type" : "string" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 edge_app_id String 应用id 最小长度:1 最大长度:64 description String 应用描述 最小长度:0 最大长度:256 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 last_published_version String 最新发布版本 最小长度:0 最大长度:64 app_type String 应用类型SYSTEM_REQUIRED|SYSTEM_OPTIONAL|USER 最小长度:0 最大长度:64 function_type String 应用类型DATA_PROCESSING|PROTOCOL_PARSING 最小长度:0 最大长度:64 deploy_type String 部署类型docker|process 最小长度:0 最大长度:64 protocol String 驱动协议类型OPCUA|Modbus-TCP 最小长度:0 最大长度:64 edge_app_name String 应用名称 最小长度:0 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 cluster_id String 集群ID cluster_name String 集群名称 最小长度:4 最大长度:32 description String 集群描述 version String 边缘集群版本 state String 边缘集群状态 os String 操作系统 arch String 集群架构 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256
  • 响应示例 状态码: 200 OK { "cluster_id" : "123343534", "cluster_name" : "test-cluster", "description" : "this is a test cluster", "version" : "string", "state" : "string", "os" : "string", "arch" : "string", "create_time" : "string", "update_time" : "string" }
  • 响应参数 状态码: 201 表11 响应Body参数 参数 参数类型 描述 edge_node_id String 边缘节点ID 最小长度:1 最大长度:64 name String 边缘节点名称 最小长度:1 最大长度:64 instance_id String 实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。 最小长度:1 最大长度:36 space_id String 资源空间id,对应IOTDA云服务接口参数中的app_id。 最小长度:1 最大长度:64 product_id String 边缘节点关联的产品ID,用于唯一标识一个产品模型。 最小长度:1 最大长度:36 product_name String 边缘节点关联的产品名称。 最小长度:1 最大长度:64 state String 边缘节点状态UNINSTALLED|INSTALLED|OFFLINE|ONLINE|DELETING|FROZEN 最小长度:4 最大长度:32 type String 节点所属资源类型:advanced|standard 最小长度:4 最大长度:16 installer_version String 安装文件版本 最小长度:1 最大长度:64 base_path BasePathDTO object 节点根目录配置 resource_ids Array of strings 资源id列表,创建节点时需绑定已购买的资源包,可以叠加节点功能。 最小长度:1 最大长度:64 ips Array of strings 边缘节点ip列表 数组长度:0 - 10 create_time String 边缘节点创建时间 最小长度:0 最大长度:256 hardware_model String 注册节点网关配置 最小长度:0 最大长度:1024 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 表12 BasePathDTO 参数 参数类型 描述 log_base_path String 节点日志根目录 最小长度:1 最大长度:64 config_base_path String 节点配置根目录 最小长度:1 最大长度:64 db_base_path String 节点数据存储根目录 最小长度:1 最大长度:64 表13 DeviceDataRecord 参数 参数类型 描述 disk_quota Integer 磁盘配额,单位MB,参考值,只能保证在这个值左右 最小值:512 最大值:10240 缺省值:512 age Integer 老化时间,日志压缩文件名时间戳老于这个时间就会发生老化删除 最小值:1 最大值:7 缺省值:1 state String 配置开关,true启用数据打印,false不启用数据打印 最小长度:0 最大长度:16
  • 响应示例 状态码: 201 Created { "edge_node_id" : "string", "name" : "string", "instance_id" : "string", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "product_id" : "string", "product_name" : "jeQDJQZltU8iKgFFoW060F5SGZka", "state" : "string", "type" : "string", "installer_version" : "string", "base_path" : { "log_base_path" : "string", "config_base_path" : "string", "db_base_path" : "string" }, "resource_ids" : [ "jeQDJQZltU8iKgFFoW060F5SGZka" ], "ips" : [ "string" ], "create_time" : "2020-05-28T11:31:29.740Z", "hardware_model" : "string", "device_data_format" : "iotda_1.0", "automatic_upgrade" : "OFF" }
  • 请求示例 { "edge_node_id" : "string", "name" : "test-node", "type" : "string", "verify_code" : "string", "time_out" : 1800, "arch" : "string", "instance_id" : "string", "space_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "resource_ids" : [ "jeQDJQZltU8iKgFFoW060F5SGZka" ], "security_level" : "HIGH", "reliability_level" : "LOW", "storage_period" : 0, "ai_card_type" : "UNEQUIPPED", "npu_library_path" : "/usr/local/Ascend/driver/lib64/", "base_path" : { "log_base_path" : "string", "config_base_path" : "string", "db_base_path" : "string" }, "log_configs" : [ { "size" : 1000, "level" : "string", "rotate_num" : 10, "rotate_period" : "string", "type" : "LTS", "component" : "string" } ], "apps" : [ { "edge_app_id" : "string", "app_version" : "string" } ], "hardware_model" : "string", "offline_cache_configs" : { "publish_order" : "realtime_first", "period" : 7, "capacity" : 2048 }, "device_auth_info" : { "auth_type" : "CERTIFICATES", "fingerprint" : "8D903AC66E0ECA7843B6EEFB50F770537C051EC3C976FD3ED3AFBECC1CC92A29", "local_path" : { "cert_path" : "/opt/device-cert/cert.pem", "key_path" : "/opt/device-cert/key.pem" } }, "automatic_upgrade" : "OFF" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 edge_node_id 否 String 边缘节点ID 最小长度:1 最大长度:64 name 是 String 边缘节点名称,只允许中、数字、英文大小写、中划线、下划线 最小长度:1 最大长度:64 type 是 String 节点所属资源类型:advanced|standard 最小长度:4 最大长度:16 verify_code 否 String 边缘节点注册使用的验证码,如果不输入则平台随机生成。 最小长度:1 最大长度:36 time_out 否 Integer 验证码的有效时间单位秒,默认1800秒,范围为1~864000,过期后平台会随机生成。 最小值:1 最大值:864000 缺省值:1800 arch 否 String 系统架构。包括:arm64,arm32,x86_64。 最小长度:4 最大长度:16 os_type 否 String 系统类型。包括:generalLinux通用系统,openHarmony。 缺省值:generalLinux 最小长度:2 最大长度:32 instance_id 否 String 实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。 最小长度:1 最大长度:36 space_id 否 String 资源空间id,对应IOTDA云服务接口参数中的app_id。 最小长度:1 最大长度:64 resource_ids 否 Array of strings 资源id列表,创建节点时需绑定已购买的资源包,资源可叠加。 最小长度:1 最大长度:64 security_level 否 String 节点的安全等级,MEDIUM表示本地明文存储,HIGH表示本地加密存储。 缺省值:MEDIUM 最小长度:1 最大长度:64 reliability_level 否 String 节点的可靠性等级。 缺省值:LOW 最小长度:1 最大长度:64 storage_period 否 Integer 节点的存储周期,默认0天,取值范围0~7天,0天则不存储。 最小值:0 最大值:7 缺省值:0 ai_card_type 否 String AI加速卡类型,如华为昇腾AI加速卡NPU、图像处理加速卡GPU。 缺省值:UNEQUIPPED 最小长度:0 最大长度:16 npu_library_path 否 String npu驱动动态库路径 最小长度:0 最大长度:256 base_path 否 BasePathDTO object 节点根目录。 log_configs 否 Array of LogConfigDTO objects 边缘节点在IEF日志配置参数,仅高级版支持。 数组长度:0 - 10 apps 否 Array of EdgeAppInstanceDTO objects 用户预置第三方边缘应用 数组长度:0 - 10 network_access_point 否 String 网络接入方式类型 缺省值:Inner 最小长度:1 最大长度:64 hardware_model 否 String 网关型号 最小长度:0 最大长度:1024 offline_cache_configs 否 OfflineCacheConfigsDTO object 边缘节点离线缓存配置 device_auth_info 否 DeviceAuthInfoDTO object 边缘节点设备认证方式 device_data_format 否 String 节点使用的数据格式,默认为iotda物模型1.0格式,可以选择属性平铺数据格式flat_json 缺省值:iotda_1.0 最小长度:0 最大长度:16 automatic_upgrade 否 String 自动升级系统应用的节点开关,默认为关闭:OFF,IMMEDIATE表示节点开关打开 缺省值:OFF 最小长度:0 最大长度:16 device_data_record 否 DeviceDataRecord object 边缘节点设备数据上报打印配置 metric_report 否 String omagent监控运维工具是否上报指标 缺省值:on 最小长度:0 最大长度:16 iotda_south_access 否 String iotda的南向接入地址 最小长度:0 最大长度:128 表4 BasePathDTO 参数 是否必选 参数类型 描述 log_base_path 否 String 节点日志根目录 最小长度:1 最大长度:64 config_base_path 否 String 节点配置根目录 最小长度:1 最大长度:64 db_base_path 否 String 节点数据存储根目录 最小长度:1 最大长度:64 表5 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 边缘设备上系统的日志 表6 EdgeAppInstanceDTO 参数 是否必选 参数类型 描述 edge_app_id 是 String 边缘应用id,只允许数字、英文小写、中划线,切必须以字母或数字结尾 最小长度:4 最大长度:32 app_version 否 String 边缘应用版本,只允许数字、英文小写、中划线,切必须以字母或数字结尾 最小长度:0 最大长度:64 表7 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 表8 DeviceAuthInfoDTO 参数 是否必选 参数类型 描述 auth_type 是 String 边缘节点认证方式,不填默认为密钥认证接入方式(SECRET)。 缺省值:SECRET fingerprint 否 String 证书指纹,认证类型使用证书认证接入(CERTIFICATES)需填写该字段。 最小长度:40 最大长度:64 local_path 否 CertificateLocalPathDTO object 证书文件的本地存储路径,认证类型使用证书认证接入(CERTIFICATES)需填写该结构体 表9 CertificateLocalPathDTO 参数 是否必选 参数类型 描述 cert_path 是 String 节点数字证书的本地存储路径。 最小长度:1 最大长度:2048 key_path 是 String 证书私钥的本地存储路径。 最小长度:1 最大长度:2048 表10 DeviceDataRecord 参数 是否必选 参数类型 描述 disk_quota 是 Integer 磁盘配额,单位MB,参考值,只能保证在这个值左右 最小值:512 最大值:10240 缺省值:512 age 是 Integer 老化时间,日志压缩文件名时间戳老于这个时间就会发生老化删除 最小值:1 最大值:7 缺省值:1 state 是 String 配置开关,true启用数据打印,false不启用数据打印 最小长度:0 最大长度:16
  • URI DELETE /v2/{project_id}/edge-nodes/{edge_node_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 delete_external_node 否 Boolean 是否同时删除外部节点(仅对高级版有效),默认为false不删除IEF侧的边缘节点 缺省值:false
  • 响应示例 状态码: 201 Created { "cluster_id" : "123343534", "cluster_name" : "test-cluster", "description" : "this is a test cluster", "version" : "string", "state" : "string", "create_time" : "string", "update_time" : "string", "is_upgradeable" : true }
  • 请求示例 GET https://{endpoint}/v3/{project_id}/clusters { "cluster_name" : "test-cluster", "description" : "this is a test cluster", "cluster_node_config" : { "master_node_vip" : "string", "master_nodes" : [ { "node_ip" : "string", "node_name" : "string" } ], "work_nodes" : [ { "node_ip" : "string", "node_name" : "string" } ] } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 cluster_name 是 String 集群名称 最小长度:4 最大长度:32 description 否 String 集群描述 最小长度:0 最大长度:1024 cluster_node_config 否 ClusterNodeConfig object 集群节点配置 表4 ClusterNodeConfig 参数 是否必选 参数类型 描述 master_node_vip 否 String master虚拟ip 最小长度:1 最大长度:64 master_nodes 否 Array of NodeConfig objects master节点数 work_nodes 否 Array of NodeConfig objects work节点数 表5 NodeConfig 参数 是否必选 参数类型 描述 node_ip 否 String 节点IP 最小长度:1 最大长度:64 node_name 否 String 节点名称 最小长度:1 最大长度:64
  • 响应参数 状态码: 201 表6 响应Body参数 参数 参数类型 描述 cluster_id String 集群ID cluster_name String 集群名称 最小长度:4 最大长度:32 description String 集群描述 version String 边缘集群版本 state String 边缘集群状态 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 is_upgradeable Boolean 是否可升级
  • URI GET /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/export-points 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 edge_node_id 是 String 边缘节点ID 最小长度:1 最大长度:64 ds_id 是 String 采集数据源id,创建数据源配置时设置,节点下唯一。 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 app_instances Array of QueryAppInstanceResp objects 应用实例列表 数组长度:0 - 1000 表4 QueryAppInstanceResp 参数 参数类型 描述 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 最后一次更新时间
  • 响应示例 状态码: 200 OK { "app_instances" : [ { "id" : "string", "namespace" : "string", "version" : "string", "app_id" : "string", "app_version" : "string", "status" : "string", "status_description" : "string", "values" : { }, "create_time" : "string", "update_time" : "string" } ] }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表4 FormData参数 参数 是否必选 参数类型 描述 chart 是 File chart包。当前仅支持tgz文件格式。 images 否 String 应用包含的镜像列表
共100000条