
# 构造请求
本节介绍REST API请求的组成，并以调用ESM服务的创建查询任务来说明如何调用API。
#### 请求URI
请求URI由如下部分组成：
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
表1URI中的参数说明 
| **参数**        | **描述**                                                                                                                                                                                                            |
|:---|:---|
| URI-scheme    | 表示用于传输请求的协议，当前所有API均采用**HTTPS**协议。                                                                                                                                                                                |
| Endpoint      | 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同。您可以从[地区和终端节点](https://developer.huaweicloud.com/endpoint?all)获取。 例如ESM服务在"**华南-广州** "区域的Endpoint为"**esm-api.cn-south-1.myhuaweicloud.com**"。 |
| resource-path | 资源路径，即API访问路径。从具体API的URI模块获取，例如"**创建查询任务**"API的resource-path为"/meter/v1/{domain_id}/query-jobs"。                                                                                                                  |
| query-string  | 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个"?"，形式为"**参数名=参数取值** "，例如"**?limit=10**"，表示查询不超过10条数据。                                                                                                                       |
   
例如您需要获取ESM在"**华南-广州** "区域的Token，则需使用"**华南-广州** "区域的Endpoint（esm-api.cn-south-1.myhuaweicloud.com），并在**创建查询任务**的URI部分找到resource-path（/meter/v1/{domain_id}/query-jobs），拼接起来如下所示。
```
https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs
```
图1URI示意图   
![](https://support.huaweicloud.com/bestpractice-esm/zh-cn_image_0000002205844873.png)
![](https://support.huaweicloud.com/bestpractice-esm/public_sys-resources/note_3.0-zh-cn.png)
为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。
#### 请求方法
HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。
表2HTTP方法 
| **方法** | **说明**              |
|:---|:---|
| GET    | 请求服务器返回指定资源。        |
| PUT    | 请求服务器更新指定资源。        |
| POST   | 请求服务器新增资源或执行特殊操作。   |
| DELETE | 请求服务器删除指定资源，如删除对象等。 |
   
在**创建查询任务** 的URI部分，您可以看到其请求方法为"**POST**"，则其请求为：
```
POST https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs
```
#### 请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头**"Content-Type"**，请求鉴权信息等。
详细的公共请求消息头字段请参见[表3]。
 表3公共请求消息头 
| **名称**       | **描述**                                                                                                                                                                                                                        | **是否必选**                                      | **示例**                                                                                |
|:---|:---|:---|:---|
| Content-Type | 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。                                                                                                                                                                       | 是                                             | application/json                                                                      |
| Accept       | 接收消息体的类型（格式），当前只支持application/json。                                                                                                                                                                                           | 否                                             | application/json                                                                      |
| X-Auth-Token | 用户Token。 用户Token也就是调用[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的"X-Subject-Token"的值即为Token值。 | 是 使用Token认证时该字段必选。 | 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ |
   
#### 请求消息体（可选）
该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
![](https://support.huaweicloud.com/bestpractice-esm/public_sys-resources/note_3.0-zh-cn.png)
对于**创建查询任务**接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，字段需要根据实际值填写。
```
POST https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs
Content-Type: application/json 
{
  "hcso_id": "********",
  "region_id": "********",
  "min_sdr_time": "2022-01-01 00:00:00",
  "max_sdr_time": "2022-02-01 00:00:00"
}
```
到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中"x-subject-token"就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
