
# 构造请求
本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token接口来说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。
您还可以通过这个视频教程了解如何构造请求调用API：<https://bbs.huaweicloud.com/videos/102987> 。
#### 请求URI
请求URI由如下部分组成。
**{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}**
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
表1请求URI 
| 参数            | 说明                                                                                                                                                                                                                                                 |
|:---|:---|
| URI-scheme    | 传输请求的协议，当前所有API均采用HTTPS协议。                                                                                                                                                                                                                         |
| Endpoint      | 承载REST服务端点的服务器域名或IP，不同服务在不同区域时，对应Endpoint不同，可以从[终端节点](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0004.html)中获取。 例如AI科学计算服务在"华东-上海一"区域的Endpoint为"ai4sservice.cn-east-3.myhuaweicloud.com"。 |
| resource-path | 资源路径，即API访问路径。从具体API的URI模块获取，例如"获取用户Token"API的resource-path为"/v3/auth/tokens"。                                                                                                                                                                     |
| query-string  | 查询参数，可选，查询参数前面需要带一个"？"，形式为"参数名=参数取值"，例如"limit=10"，表示查询不超过10条数据。                                                                                                                                                                                    |
   
例如，您需要获取IAM在"华东-上海一"区域的Token，则需使用"华东-上海一"区域的Endpoint（iam.cn-east-3.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。
```
https://iam.cn-east-3.myhuaweicloud.com/v3/auth/tokens
```
![](https://support.huaweicloud.com/api-ai4sservice/public_sys-resources/note_3.0-zh-cn.png)
为查看方便，服务每个具体API的URI，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。
#### 请求方法
HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。
表2HTTP请求方法 
| 方法     | 说明                                          |
|:---|:---|
| GET    | 请求服务器返回指定资源.                                |
| PUT    | 请求服务器更新指定资源。                                |
| POST   | 请求服务器新增资源或执行特殊操作。                           |
| DELETE | 请求服务器删除指定资源，如删除对象等。                         |
| HEAD   | 请求服务器资源头部。                                  |
| PATCH  | 请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 |
   
在获取用户Token的URI部分，您可以看到其请求方法为 "POST"，则其请求为：
```
POST https://iam.cn-east-3.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json
X-Auth-Token: ABCDEFJ....
```
#### 请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头"Content-Type"，请求鉴权信息等。
如下公共消息头需要添加到请求中。
表3公共请求消息头 
| 参数名          | 说明                                  | 是否必选 | 示例               |
|:---|:---|:---|:---|
| Content-type | 消息体的类型（格式），默认取值为"application/json"。 | 是    | application/json |
   
例如，对于[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口，由于不需要认证，所以只添加"Content-Type"即可，添加消息头后的请求如下所示。
```
POST https://iam.cn-east-3.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json
```
#### 请求消息体
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。如果请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中**username** 为用户名，**domainname** 为用户所属的账号名称，**\*\*\*\*\*\*\*\*** 为用户登录密码，cn-east-3为project的名称，获取方法请参见[获取用户名、账号名和项目name](https://support.huaweicloud.com/api-iam/iam_17_0002.html)。
![](https://support.huaweicloud.com/api-ai4sservice/public_sys-resources/note_3.0-zh-cn.png)
scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。
```
POST https://iam.cn-east-3.myhuaweicloud.com/v3/auth/tokens
Content-Type:application/json
{
  "auth": {
    "identity": {
      "methods": ["password"],
      "password": {
        "user": {
          "name": "username",  
          "password": "**********",
          "domain": {
            "name": "domainname"  
          }
        }
      }
    },
    "scope": {
      "project": {
        "name": "xxxxxxxx" //替换为实际的project name，如cn-east-3  
      }
    }
  }
}
```
到这里为止这个请求需要的内容就齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中"x-subject-token"就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
