
# 构造请求
本节介绍REST API请求的组成，并以调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。
您还可以通过这个视频教程了解如何构造请求调用API：<https://bbs.huaweicloud.com/videos/102987> 。
请求示例如下所示，一个请求主要由请求URL、请求方法、请求消息头和请求消息体几部分组成，各个部分将在下文详细解释。
图1请求示例图   
![](https://support.huaweicloud.com/api-cbs/zh-cn_image_0209427889.png "点击放大")
#### 请求URI
请求URI由如下部分组成。
**{URI-scheme} :// {**Endpoint**} / {resource-path} ? {query-String}**
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此强调。
表1URI中的参数说明 
| 参数            | 描述                                                                                                                                                                                                                                                   |
|:---|:---|
| URI-scheme    | 表示用于传输请求的协议，当前所有API均采用**HTTPS**协议。                                                                                                                                                                                                                   |
| Endpoint      | 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从[地区和终端节点](https://developer.huaweicloud.com/endpoint?CBS)中获取。例如对话机器人服务在"华北-北京四"区域的Endpoint为"cbs-ext.cn-north-4.myhuaweicloud.com"。                                                                     |
| resource-path | 资源路径，也即API访问路径。从具体API的URI模块获取，例如"问答机器人获取问题提示"API的resource-path为"/v1/{project_id}/qabots/{qabot_id}/suggestions"。其中{project_id}为项目编号，请参考[获取项目ID](https://support.huaweicloud.com/api-cbs/cbs_03_0069.html)获取，{qabot_id}为智能问答机器人编号，可在CBS服务智能问答机器人首页获取。 |
| query-String  | 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个"？"，形式为"参数名=参数取值"，例如"limit=10"，表示查询不超过10条数据。当前CBS服务未使用该参数。                                                                                                                                                      |
   
例如，您需要获取"华北-北京四"区域的调用获取问题提示API，则需使用"华北-北京四"区域的Endpoint（cbs-ext.cn-north-4.myhuaweicloud.com），并在[获取问题提示](https://support.huaweicloud.com/api-cbs/cbs_03_0071.html)的URI部分找到resource-path（/v1/{project_id}/qabots/{qabot_id}/suggestions），拼接起来如下所示。
```
https://cbs-ext.cn-north-4.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/suggestions
```
图2URI示意图   
![](https://support.huaweicloud.com/api-cbs/zh-cn_image_0209056719.png "点击放大")
![](https://support.huaweicloud.com/api-cbs/public_sys-resources/note_3.0-zh-cn.png)
为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。
#### 请求方法
HTTPS方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。
表2HTTPS方法 
| 方法     | 说明                                                                       |
|:---|:---|
| GET    | 请求服务器返回指定资源。                                                             |
| PUT    | 请求服务器更新指定资源。                                                             |
| POST   | 请求服务器新增资源或执行特殊操作。                                                        |
| DELETE | 请求服务器删除指定资源，如删除对象等。                                                      |
| HEAD   | 请求服务器资源头部。                                                               |
| PATCH  | 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 |
   
在-[获取问题提示](https://support.huaweicloud.com/api-cbs/cbs_03_0071.html)的URI部分，您可以看到其请求方法为"POST"，则其请求为：
```
POST https://cbs-ext.cn-north-1.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/suggestions
```
#### 请求消息头
可选的附加请求头字段，如指定的URI和HTTPS方法所要求的字段。详细的公共请求消息头字段请参见[表3]，其中请求认证信息请参见[认证鉴权](https://support.huaweicloud.com/api-cbs/cbs_03_0006.html)。
 表3公共请求消息头 
| 名称             | 描述                                                                                              | 是否必选                      | 示例                                                                      |
|:---|:---|:---|:---|
| Content-type   | 发送的实体的MIME类型。                                                                                   | 是                         | application/json                                                        |
| Content-Length | 请求body长度，单位为Byte。                                                                               | POST/PUT请求为可选， GET不包含该字段。 | 3495                                                                    |
| X-Auth-Token   | 用户Token。用于获取操作API的权限。获取方法请见[Token认证](https://support.huaweicloud.com/api-cbs/cbs_03_0006.html)。 | 是                         | MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... |
| X-Language     | 请求语言类型。                                                                                         | 否，默认为zh-cn。               | en-us                                                                   |
   
![](https://support.huaweicloud.com/api-cbs/public_sys-resources/note_3.0-zh-cn.png)
公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。
AK/SK认证的详细说明请参见[AK/SK认证](https://support.huaweicloud.com/api-cbs/cbs_03_0006.html#cbs_03_0006__section772991411415)。
对于[获取问题提示](https://support.huaweicloud.com/api-cbs/cbs_03_0071.html)接口，由于需要认证，所以需要添加"Content-Type"和"X-Auth-Token"，添加消息头后的请求如下所示。
```
POST https://cbs-ext.cn-north-1.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/suggestions
Content-Type: application/json
X-Auth-Token：MIIaBgYJKoZIhvcNAQcC……
```
#### 请求消息体
请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。如果请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口不需要消息体，消息体具体内容需要根据具体接口而定。
对于[获取问题提示](https://support.huaweicloud.com/api-cbs/cbs_03_0071.html)接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。
```
POST https://cbs-ext.cn-north-1.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/suggestions
Content-Type: application/json
X-Auth-Token：MIIaBgYJKoZIhvcNAQcC……
{
    "question":"桌面云",
    "top":2
}
```
到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于[获取问题提示](https://support.huaweicloud.com/api-cbs/cbs_03_0071.html)接口，您可以从响应消息部分看到返回参数及参数说明。
