PDF《智能边缘平台》

智能边缘平台 API 参考 文档版本

01 发布日期 2019-05-24 华为技术有限公司 版权所有 ? 华为技术有限公司 2019.

保留一切权利. 非经本公司书面许可,任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部,并不得以任何形式传 播. 商标声明 和其他华为商标均为华为技术有限公司的商标. 本文档提及的其他所有商标或注册商标,由各自的所有人拥有. 注意 您购买的产品、服务或特性等应受华为公司商业合同和条款的约束,本文档中描述的全部或部分产品、服务或 特性可能不在您的购买或使用范围之内.除非合同另有约定,华为公司对本文档内容不做任何明示或默示的声 明或保证. 由于产品版本升级或其他原因,本文档内容会不定期进行更新.除非另有约定,本文档仅作为使用指导,本文 档中的所有陈述、信息和建议不构成任何明示或暗示的担保. 文档版本

01 (2019-05-24) 版权所有 ? 华为技术有限公司 i 目录1使用前必读.1 1.1 概述.1 1.2 调用说明.1 1.3 终端节点.1 1.4 约束限制.1 1.5 基本概念.2

2 API 概览.3

3 如何调用 API.4 3.1 构造请求.4 3.2 认证鉴权.6 3.3 返回结果.7

4 示例.9

5 API.12 5.1 边缘节点管理.12 5.1.1 创建边缘节点.12 5.1.2 更新边缘节点.15 5.1.3 查询边缘节点详情.17 5.1.4 查询边缘节点列表.19 5.1.5 删除边缘节点.22 5.1.6 启用停用边缘节点.22 5.1.7 检查边缘节点更新.24 5.2 边缘设备管理.25 5.2.1 创建边缘设备.25 5.2.2 更新边缘设备.27 5.2.3 查询边缘设备详情.29 5.2.4 查询边缘设备列表.31 5.2.5 删除边缘设备.33 5.2.6 更新边缘设备的边缘节点.34 5.2.7 查询边缘设备孪生.35 5.2.8 更新边缘设备孪生.37 5.2.9 禁用启用直连设备.39 5.3 边缘设备模板管理.40 智能边缘平台 API 参考 目录文档版本

01 (2019-05-24) 版权所有 ? 华为技术有限公司 ii 5.3.1 创建边缘设备模板.40 5.3.2 更新边缘设备模板.44 5.3.3 查询边缘设备模板.46 5.3.4 查询边缘设备模板列表.47 5.3.5 删除边缘设备模板.49 5.4 应用模板管理.50 5.4.1 创建应用.50 5.4.2 更新应用.52 5.4.3 查询应用详情.54 5.4.4 查询应用列表.56 5.4.5 删除应用.58 5.4.6 创建应用版本.59 5.4.7 更新应用版本.61 5.4.8 查询应用版本详情.64 5.4.9 查询应用版本列表.66 5.4.10 删除应用版本.68 5.5 部署管理.69 5.5.1 创建部署.69 5.5.2 更新部署.72 5.5.3 查询部署详情.77 5.5.4 查询部署列表.78 5.5.5 删除部署.81 5.6 标签管理.82 5.6.1 查询资源实例.82 5.6.2 批量添加删除资源标签.87 5.6.3 添加资源标签.90 5.6.4 删除资源标签.91 5.6.5 查询资源标签.93 5.6.6 查询项目标签.95 5.7 配置管理.97 5.7.1 创建配置.97 5.7.2 更新配置.99 5.7.3 查询配置详情.101 5.7.4 查询配置列表.102 5.7.5 删除配置.104 5.8 产品管理.105 5.8.1 边缘节点注册.105 5.8.2 直连设备注册.106

6 数据结构.109

7 附录.122 7.1 获取项目 ID.122 7.2 状态码.123 智能边缘平台 API 参考 目录文档版本

01 (2019-05-24) 版权所有 ? 华为技术有限公司 iii 7.3 错误码.125 7.4 标签字符集规范.133 智能边缘平台 API 参考 目录文档版本

01 (2019-05-24) 版权所有 ? 华为技术有限公司 iv 1使用前必读 1.1 概述 1.2 调用说明 1.3 终端节点 1.4 约束限制 1.5 基本概念 1.1 概述 智能边缘平台(Intelligent EdgeFabric)通过纳管您的边缘节点,提供将云上应用延伸 到边缘的能力,联动边缘和云端的数据,满足客户对边缘计算资源的远程管控、数据 处理、分析决策、智能化的诉求,同时,在云端提供统一的设备/应用监控、日志采集 等运维能力,为企业提供完整的边缘和云协同的一体化服务的边缘计算解决方案. 您可以使用本文档提供API对智能边缘平台进行相关操作,如创建、删除等.支持的全 部操作请参见API概览. 在调用智能边缘平台API之前,请确保已经充分了解相关概念,详细信息请参见产品介 绍. 1.2 调用说明 智能边缘平台提供了REST(Representational State Transfer)风格API,支持您通过 HTTPS请求调用,调用方法请参见3 如何调用API. 1.3 终端节点 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同,您 可以从地区和终端节点中查询所有服务的终端节点. 1.4 约束限制 约束与限制请参见具体API的说明. 智能边缘平台 API 参考

1 使用前必读 文档版本

01 (2019-05-24) 版权所有 ? 华为技术有限公司

1 1.5 基本概念 l 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以 重置用户密码、分配用户权限等.由于账号是付费主体,为了确保账号安全,建 议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管 理工作. l 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问 密钥). 在我的凭证下,您可以查看账号ID和用户ID.通常在调用API的鉴权过程中,您需 要用到账号、用户和密码等信息. l 区域 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互 通.通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要 求,或满足不同地区的法律或其他要求. l 可用区 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上 再将计算、网络、存储等资源划分成多个集群.一个Region中的多个AZ间通过高 速光纤相连,以满足用户跨AZ构建高可用性系统的需求. l 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计 算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您 账号中该区域的所有资源.如果您希望进行更加精细的权限控制,可以在区域默 认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授 权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确. 图1-1 项目隔离模型 智能边缘平台 API 参考

1 使用前必读 文档版本

01 (2019-05-24) 版权所有 ? 华为技术有限公司

2 2API 概览 通过使用边缘计算平台API接口,您可以使用边缘计算的部分功能,包括创建更新边缘 节点、设备、应用,更新和查询边缘计算日志配置等. 类型 说明 5.1 边缘节点管理 边缘节点管理接口,包括边缘计算节点的创建,查询,修改,删除等接口. 5.2 边缘设备管理 边缘设备管理接口,包括边缘计算设备的创建,查询,修改,删除等接口. 5.3 边缘设备模板管 理 边缘设备模板管理接口,包括边缘计算设备模板的创建,查询,修改,删除等接口 5.4 应用模板管理 应用管理接口,包括边缘计算应用的创建,查询,修改,删 除等接口. 5.5 部署管理 边部署管理接口,包括边缘计算应用部署的创建,查询,修改,删除等接口. 5.6 标签管理 标签管理接口,包括边缘计算标签的添加、查询,删除等接 口. 5.7 配置管理 配置管理接口,包括边缘计算配置的创建、更新、查询、删 除等接口. 5.8 产品管理 产品管理接口,包括边缘节点注册、直连设备注册. 智能边缘平台 API 参考

2 API 概览 文档版本

01 (2019-05-24) 版权所有 ? 华为技术有限公司

3 3如何调用 API 3.1 构造请求 3.2 认证鉴权 3.3 返回结果 3.1 构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用 API,该API获取用户的Token,Token可以用于调用其他API时鉴权. 请求 URI 请求URI由如下部分组成. {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传 递它,所以在此单独强调. l URI-scheme: 表示用于传输请求的协议,当前所有API均采用HTTPS协议. l Endpoint: 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同, 您可以管理员处地区和终端节点获取. 例如IAM服务在 华北-北京一 区域的Endpoint为 iam.cn- north-1.myhuaweicloud.com . l resource-path: 资源路径,也即API访问路径.从具体API的URI模块获取,例如 获取用户 Token API的resource-path为 /v3/auth/tokens . l query-string: 查询参数,是可选部分,并不是每个API都有查询参数.查询参数前面需要带一个 ? ,形式为 参数名=参数取值 ,例如 limit=10 ,表示查询不超过10条 数据. 智能边缘平台 API 参考

3 如何调用 API 文档版本

01 (2019-05-24) 版权所有 ? 华为技术有限公司

4 例如您需要获取IAM在 华北-北京一 区域的Token,则需使用 华北-北京一 区域 的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部分找到 resource-path(/v3/auth/tokens),拼接起来如下所示. https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图3-1 URI 示意图 说明 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起.这 是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省 略. 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作. l GET:请求服务器返回指定资源. l PUT:请求服务器更新指定资源. l POST:请求服务器新增资源或执行特殊操作. l DELETE:请求服务器删除指定资源,如删除对象等. l HEAD:请求服务器资源头部. l PATCH:请求服务器更新资源的部分内容.当资源不存在的时候,PATCH可能会 去创建一个新的资源. 在获取用户Token的URI部分,您可以看到其请求方法为 POST ,则其请求为: POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段.例如定义消息体类型的请 求头 Content-Type ,请求鉴权信息等. 如下公共消息头需要添加到请求中. l Content-Type:消息体的类型(格式),必选,默认取值为 application/json , 有其他取值时会在具体接口中专门说明. l X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段. 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的 接口. 说明 公有云API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会 自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求 头. AK/SK认证的详细说明请参见AK/SK认证. 智能边缘平台 API 参考

3 如何调用 API 文档版本

01 (2019-05-24) 版权所有 ? 华为技术有限公司

5 对于获取用户Token接口,由于不需要认证,所以只添加 Content-Type 即可,添加 消息头后的请求如下所示. POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消 息头之外的内容.若请求消息体中参数支持中文,则中文字符必须为UTF-8编码. 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消 息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根 据具体接口而定. 对于获取用户Token接口,您可以从接口的请求部分看........