
# 构造请求
本节介绍REST API请求的组成，并以调用物联网平台的[查询产品 - ShowProduct](https://support.huaweicloud.com/api-iothub/iot_06_v5_0052.html)和[创建产品 - CreateProduct](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)接口说明如何调用API，该API可用于获取用户的指定产品信息。
#### 请求URI
请求URI由如下部分组成。
**{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}**
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
- **URI-scheme** ：表示用于传输请求的协议，当前所有API均采用**HTTPS**协议。
- **Endpoint** ：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以参考[如何获取平台接入地址](https://support.huaweicloud.com/iothub_faq/iot_faq_00123.html)。
- **resource-path**：资源路径，也即API访问路径。从具体API的URI模块获取，例如"查询产品"API的resource-path为"/v5/iot/{project_id}/products/{product_id}"。
- **query-string**：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个"？"，形式为"参数名=参数取值"，例如"limit=10"，表示查询不超过10条数据。
例如您需要在物联网平台获取在"华北-北京四"区域下的指定产品信息，则需使用"华北-北京四"区域的Endpoint（iotda.cn-north-4.myhuaweicloud.com），并在[查询产品 - ShowProduct](https://support.huaweicloud.com/api-iothub/iot_06_v5_0052.html)的URI部分找到resource-path（/v5/iot/{project_id}/products/{product_id}），拼接起来如下所示。
```
https://iotda.cn-north-4.myhuaweicloud.com/v5/iot/{project_id}/products/{product_id}
```
![](https://support.huaweicloud.com/api-iothub/public_sys-resources/note_3.0-zh-cn.png)
为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。
#### 请求方法
HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。
- **GET**：请求服务器返回指定资源。
- **PUT**：请求服务器更新指定资源。
- **POST**：请求服务器新增资源或执行特殊操作。
- **DELETE**：请求服务器删除指定资源，如删除对象等。
- **HEAD**：请求服务器资源头部。
- **PATCH**：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。
在[查询产品 - ShowProduct](https://support.huaweicloud.com/api-iothub/iot_06_v5_0052.html)的URI部分，您可以看到其请求方法为"GET"，则其请求为：
```
GET https://{Endpoint}/v5/iot/{project_id}/products/{product_id}
```
#### 请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头"Content-Type"，请求鉴权信息等。
如下公共消息头需要添加到请求中。
- **Content-Type**：消息体的类型（格式），必选，默认取值为"application/json;charset=utf-8"，有其他取值时会在具体接口中专门说明。
- **X-Auth-Token** ：用户Token。当使用Token方式认证时，必须填充该字段，可通过调用[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取，接口返回的响应消息头中"X-Subject-Token"就是需要获取的用户Token。
对于[查询产品 - ShowProduct](https://support.huaweicloud.com/api-iothub/iot_06_v5_0052.html)接口，由于需要认证，所以需要添加"Content-Type"和"X-Auth-Token"到头域，添加消息头后的请求如下所示。
```
GET https://{Endpoint}/v5/iot/{project_id}/products/{product_id}
```
```
Content-Type: application/json
X-Auth-Token：******
```
#### 请求消息体
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于[创建产品 - CreateProduct](https://support.huaweicloud.com/api-iothub/iot_06_v5_0050.html)接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，如：其中***name*** 为产品名称，***device_type*** 为设备类型，***protocol_type***为设备使用的协议类型。
```
POST https://{Endpoint}/v5/iot/abab***cdcd/products
Content-Type: application/json 
X-Auth-Token: ********
{
  "name" : "Thermometer",
  "device_type" : "Thermometer",
  "protocol_type" : "MQTT",
  "data_format" : "binary",
  "manufacturer_name" : "ABC",
  "industry" : "smartCity",
  "description" : "this is a thermometer produced",
  "service_capabilities" : [ {
    "service_type" : "temperature",
    "service_id" : "temperature",
    "description" : "temperature",
    "properties" : [ {
      "unit" : "centigrade",
      "min" : "1",
      "method" : "R",
      "max" : "100",
      "data_type" : "decimal",
      "description" : "force",
      "step" : 0.1,
      "enum_list" : [ "string" ],
      "required" : true,
      "property_name" : "temperature",
      "max_length" : 100
    } ],
    "commands" : [ {
      "command_name" : "reboot",
      "responses" : [ {
        "response_name" : "ACK",
        "paras" : [ {
          "unit" : "km/h",
          "min" : "1",
          "max" : "100",
          "para_name" : "force",
          "data_type" : "string",
          "description" : "force",
          "step" : 0.1,
          "enum_list" : [ "string" ],
          "required" : false,
          "max_length" : 100
        } ]
      } ],
      "paras" : [ {
        "unit" : "km/h",
        "min" : "1",
        "max" : "100",
        "para_name" : "force",
        "data_type" : "string",
        "description" : "force",
        "step" : 0.1,
        "enum_list" : [ "string" ],
        "required" : false,
        "max_length" : 100
      } ]
    } ],
    "option" : "Mandatory"
  } ],
  "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka"
}
```
到此请求需要的内容已具备齐全，您可以使用[curl](https://curl.haxx.se/)、[Postman](https://www.getpostman.com/)或直接编写代码等方式发送请求调用API。
