构造请求
请求URI
请求URI由如下部分组成。
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
|
参数 |
说明 |
|---|---|
|
URI-scheme |
传输请求的协议，当前所有API均采用HTTPS协议。 |
|
Endpoint |
承载REST服务端点的服务器地址，为“host:port”格式，host为服务器的访问域名或IP，port为服务器的访问端口，您可以参考平台对接信息获取应用的接入地址和端口信息。 例如设备管理服务在“华北-北京四”区域的应用对接地址为“iot-api.cn-north-4.myhuaweicloud.com”，端口为“8743”，所以Endpoint为“iot-api.cn-north-4.myhuaweicloud.com:8743”。 |
|
resource-path |
资源路径，即API访问路径。从具体API的URI信息处获取，例如鉴权接口的resource-path为“/iocm/app/sec/v1.1.0/login”。 |
|
query-string |
查询参数，可选，格式为“参数名=参数取值”，例如“pageSize=10”，表示每页最多显示10条查询记录。 查询参数与resource-path之间以“?”分隔，多个查询参数之间以“&”分隔。 |
例如您需要获取“华北-北京四”区域设备管理服务的accessToken，查询到的Endpoint为“iot-api.cn-north-4.myhuaweicloud.com:8743”，并在鉴权接口的URI信息处找到resource-path为“/iocm/app/sec/v1.1.0/login”，拼接起来的请求URI如下所示。
https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/sec/v1.1.0/login
以批量查询设备信息接口为例，带query-string参数的请求URI如下所示。
https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/dm/v1.4.0/devices?pageNo=0&pageSize=10
请求方法
HTTP请求方法（也称为操作），它告诉服务你正在请求什么类型的操作。
|
方法 |
说明 |
|---|---|
|
POST |
请求服务器新增资源或执行特殊操作。 |
|
GET |
请求服务器返回指定资源。 |
|
PUT |
请求服务器更新指定资源。 |
|
DELETE |
请求服务器删除指定资源，如删除对象等。 |
在鉴权接口的URI信息处，您可以看到其请求方法为“POST”，则其请求为：
POST https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/sec/v1.1.0/login
请求消息头
附加请求头（header）字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。
|
参数 |
是否必选 |
说明 |
|---|---|---|
|
Content-Type |
必选 |
消息体的媒体类型，默认取值为“application/json”。
|
|
app_key |
鉴权接口不选 其他接口必选 |
|
|
Authorization |
鉴权接口不选 其他接口必选 |
访问物联网平台的认证信息，值为“Bearer {accessToken}”，其中{accessToken}为调用鉴权接口返回的accessToken。 |
Token在计算机系统中代表临时令牌的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。Token是有有效时间的，Token过期后需要重新认证并获取新的
对于鉴权接口，由于不需要认证，所以只添加Content-Type即可，添加消息头后的请求如下所示。
POST https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/sec/v1.1.0/login Content-Type: application/x-www-form-urlencoded
对于其他接口，还需要在请求消息头中添加app_key和Authorization，以注册设备（验证码方式）接口为例，添加消息头后的请求如下所示，“******”需要根据实际值填写。
POST https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/reg/v1.1.0/deviceCredentials Content-Type: application/json app_key: ****** Authorization: Bearer ******
请求消息体
请求消息体通常以结构化格式发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于鉴权接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，“******”需要根据实际值填写。
POST https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/sec/v1.1.0/login Content-Type: application/x-www-form-urlencoded appId=******&secret=******
鉴权接口的Content-Type为“application/x-www-form-urlencoded”，其消息体格式与Content-Type值为“application/json”时有差别。以注册设备（验证码方式）接口为例，其请求示例如下所示，“******”需要根据实际值填写。
POST https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/reg/v1.1.0/deviceCredentials
Content-Type: application/json
app_key: ******
Authorization: Bearer ******
{
"nodeId": "******",
"productId": "******",
"timeout": 0
}
到这里为止这个请求需要的内容就具备齐全了，您可以使用cURL、Postman或直接编写代码等方式发送请求调用API。
