- 最新动态
- 产品介绍
- 快速入门
- 用户指南
- 开发指南
- 最佳实践
- API参考
- SDK参考
- 场景代码示例
-
常见问题
- 概念相关
-
节点管理
- 安装专业版节点异常如何处理？
- 安装专业版节点，执行安装命令时失败，一直提示“edgedaemon not found"？
- 安装专业版节点失败，提示“edge_core has existed”，该如何处理？
- 专业版节点所在机器断网/断电一段时间后恢复，节点模块一直处于“部署中”怎么处理？
- 专业版节点欠费充值后，部署、升级模块仍然报错？
- MQTT设备无法接入边缘节点如何处理？专业版节点所在机器断网/断电一段时间后恢复，节点模块一直处于“部署中”怎么处理？
- 误删除IoTDA上的edge_node/modbus_server产品后，在边缘服务创建节点/添加Modbus设备失败，该怎么处理？
- 边缘节点离线排查指南
- 修改专业版（Docker）或基础版节点的云端日志级别，但没有生效？
- ubuntu系统下节点shell命令兼容性导致的安装失败
- 子设备管理
- 应用管理
- 账号与权限
- Module-SDK
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
构造请求
本节介绍REST API请求的组成，并以调用IoT边缘平台的查询北向NA信息详情和创建&更新北向NA信息接口说明如何调用API，该API可用于获取用户的指定北向NA信息。
请求URI
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
- URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。
- Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。例如IoT边缘平台在“华北-北京四”区域的Endpoint为“iotedge-api.cn-north-4.myhuaweicloud.com”。
- resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“查询北向NA信息详情”API的resource-path为“/v2/{project_id}/nas/{na_id}”。
- query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。
例如您需要在IoT边缘平台获取应用接入地址的信息, 并在查询北向NA信息详情的URI部分找到resource-path（/v5/iot/{project_id}/products/{product_id}），拼接起来如下所示。
https://100.xxx.xxx.220/v2/{project_id}/nas/{na_id}
说明：
为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。
请求方法
HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。
- GET：请求服务器返回指定资源。
- PUT：请求服务器更新指定资源。
- POST：请求服务器新增资源或执行特殊操作。
- DELETE：请求服务器删除指定资源，如删除对象等。
- HEAD：请求服务器资源头部。
在查询北向NA信息详情的URI部分，您可以看到其请求方法为“GET”，则其请求为：
GET https://{Endpoint}/v2/{project_id}/nas/{na_id}请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。
如下公共消息头需要添加到请求中。
- Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。
- X-Auth-Token：用户Token。当使用Token方式认证时，必须填充该字段，可通过调用获取用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。
对于查询北向NA信息详情接口，由于需要认证，所以需要添加“Content-Type”和“X-Auth-Token”到头域，添加消息头后的请求如下所示。
GET https://{Endpoint}/v2/{project_id}/nas/{na_id}Content-Type: application/json X-Auth-Token：eyJhbGciOiJSUzUxMiJ9.eyJpc3MiOiJpb3Rzd...
请求消息体
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于创建&更新北向NA信息接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。
POST https://{Endpoint}/v2/{project_id}/nas/{na_id}
Content-Type: application/json
X-Auth-Token: eyJhbGciOiJSUzUxMiJ9.eyJpc3MiOiJpb3Rzd...
{
"name" : "北向系统1",
"description" : "这是一个北向NA",
"endpoint" : "https://068b72f3b75444dda67cc6e2286a4c20.apic.cn-south-1.huaweicloudapis.com",
"auth_type" : "AKSK",
"auth_aksk_info" : {
"secret" : "123456"
},
"access_type" : "ROMA",
"access_roma_info" : {
"app_key" : "ebf59208-4c6b-4b06-9b69-494e9df475a3",
"app_secret" : "fa3c8cd144b29771b5873ae6a7efa25b393c86665d2e9ffa34d1309c5cd704ea"
}
}
