检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
调用说明 智能边缘平台提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户
边缘文件服务:SystemREST到Service Bus,通过调用云端的REST Gateway接口,获取边缘节点上的文件服务。 边缘消息下发服务:SystemREST到SystemEventBus,通过调用云端的REST Gateway接口,向边缘节点中的SystemEventBus(MQTT
与其他云服务的关系 IEF与其他服务之间的关系如图1所示。 图1 IEF与其他服务之间的关系 表1 IEF与其他服务之间的关系 云服务名称 描述 SWR 边缘节点从SWR拉取容器镜像。 OBS 用户可以将边缘节点生成的数据上传到OBS存储,从而在云上做进一步处理。 AOM 边缘节
目前支持如下几种消息转发路径: SystemREST到Service Bus:通过调用云端的REST Gateway接口,获取边缘节点上的文件服务。需配合边缘市场中的边缘文件服务应用一起使用。 SystemREST到SystemEventBus:通过调用云端的REST Gateway接口,向边缘节点中的SystemEventBus(MQTT
服务或用户自己部署在云端的应用中。 边缘侧的Kuiper Container负责对接边缘侧其他系统获取数据。 边缘侧Kuiper的数据处理函数和数据源为插件式,可以由社区、ISV或华为等开发并预置。该插件也可以由IEF在云端进行管理进行插拔。 该方案由如下几个角色构成,在实际项目
终端节点(Endpoint) 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询智能边缘平台的终端节点。 表1 IEF的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京一 cn-north-1 ief2
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET ht
是否必选 参数类型 描述 relation 否 String 终端设备和节点关系的名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64 comment 否 String 终端设备和节点关系的描述,最大长度64,不允许^ ~ # $ % & * < > ( ) [ ]
参数 是否必选 参数类型 描述 relation 是 String 设备和节点关系的名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64 comment 否 String 设备和节点关系的描述,最大长度64,不允许^ ~ # $ % & * < > ( ) [ ] {
设备成员变更 绑定终端设备关系变化。 Topic $hw/events/node/{node_id}/membership/updated 参数 类型 说明 node_id String 节点ID 使用方式 使用MQTT客户端订阅该Topic。 参数说明 参数 类型 说明 event_id
设备成员变更 绑定终端设备关系变化。 Topic $hw/events/node/{node_id}/membership/updated 参数 类型 说明 node_id String 节点ID 使用方式 使用MQTT客户端订阅该Topic。 参数说明 参数 类型 说明 event_id
是否必选 参数类型 描述 relation 否 String 终端设备和节点关系的名称,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64 comment 否 String 终端设备和节点关系的描述,最大长度64,不允许^ ~ # $ % & * < > ( ) [ ]
G端点,以便您及时感知资源的变化。 系统订阅是边云消息的一种特定实现,IEF发送特定资源的事件消息到指定Topic,并调用APIG的API,用户可通过API调用感知资源的变化。 支持订阅的事件 当前支持订阅如下事件。 表1 支持订阅的事件 系统事件 Topic 资源类型 操作 实例创建
G端点,以便您及时感知资源的变化。 系统订阅是边云消息的一种特定实现,IEF发送特定资源的事件消息到指定Topic,并调用APIG的API,用户可通过API调用感知资源的变化。 支持订阅的事件 当前支持订阅如下事件。 表1 支持订阅的事件 系统事件 Topic 资源类型 操作 实例创建
部署容器应用,因此需要获得访问容器镜像服务的权限 OBS服务 IEF 支持通过对象存储服务(OBS)访问您创建的边缘函数,帮助用户在边缘节点、设备上部署并运行函数,因此需要获得访问对象存储服务的权限 DIS服务 IEF 支持通过将边缘节点、设备上的数据发送到用户的数据接入服务(D
部署容器应用,因此需要获得访问容器镜像服务的权限 OBS服务 IEF 支持通过对象存储服务(OBS)访问您创建的边缘函数,帮助用户在边缘节点、设备上部署并运行函数,因此需要获得访问对象存储服务的权限 DIS服务 IEF 支持通过将边缘节点、设备上的数据发送到用户的数据接入服务(D