
# 构造请求
本节介绍如何构造REST API的请求，并以调用APIG服务的[创建API分组（专享版API）](https://support.huaweicloud.com/api-apig/CreateApiGroupV2.html)说明如何调用API。
#### 请求URI
请求URI由如下部分组成。
**{URI-scheme} :// {**Endpoint**} / {resource-path} ? {query-string}**
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
- **URI-scheme** ：表示用于传输请求的协议，当前所有API均采用**HTTPS**协议。
- **Endpoint** ：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从[终端节点](https://support.huaweicloud.com/api-apig/apig-api-190529263.html#apig-api-190529263__zh-cn_topic_0000001969180093_section932113578479)中获取。例如APIG服务在"华北-北京四"区域的Endpoint为"apig.cn-north-4.myhuaweicloud.com"。
- **resource-path** ：资源路径，也即API访问路径。从具体API的URI模块获取，例如"**创建API分组** （专享版API）"API的resource-path为"/v2/{project_id}/apigw/instances/{instance_id}/api-groups"，project_id为[项目ID](https://support.huaweicloud.com/api-apig/apig-api-180713009.html)，instance_id为实例ID（在APIG控制台的"实例信息"中查看）。
- **query-string**：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个"?"，形式为"参数名=参数取值"，例如"limit=10"，表示查询不超过10条数据。
例如您需要在"华北-北京四"区域创建API分组，**URI-scheme** 为"https"，**Endpoint** 为"apig.cn-north-4.myhuaweicloud.com"，**resource-path**为"/v2/{project_id}/apigw/instances/{instance_id}/api-groups"，将URI中的参数拼接起来即可。
```
https://apig.cn-north-4.myhuaweicloud.com/v2/{project_id}/apigw/instances/{instance_id}/api-groups
```
![](https://support.huaweicloud.com/api-apig/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可能会去创建一个新的资源。
在[创建API分组](https://support.huaweicloud.com/api-apig/CreateApiGroupV2.html)的URI部分，您可以看到其请求方法为"POST"，则其请求为：
```
POST https://apig.cn-north-1.myhuaweicloud.com/v2/{project_id}/apigw/instances/{instance_id}/api-groups
```
#### 请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头"Content-Type"，请求鉴权信息等。
如下公共消息头需要添加到请求中。
- **Content-Type**：消息体的类型（格式），必选，默认取值为"application/json"，有其他取值时会在具体接口中专门说明。
- **X-Sdk-Date** ：请求发送的时间，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参考[AK/SK认证](https://support.huaweicloud.com/api-apig/apig-api-190529268.html#apig-api-190529268__zh-cn_topic_0172440411_section5887143815518)。
- **Authorization** ：签名认证信息，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参考[AK/SK认证](https://support.huaweicloud.com/api-apig/apig-api-190529268.html#apig-api-190529268__zh-cn_topic_0172440411_section5887143815518)。
- **X-Auth-Token** ：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口的响应值，该接口是唯一不需要认证的接口。
- **X-Project-ID**：子项目ID，可选，在多项目场景中使用。如果云服务资源创建在子项目中，AK/SK认证方式下，操作该资源的接口调用需要在请求消息头中携带X-Project-ID。
- **X-Domain-ID**：账号ID，可选。AK/SK认证方式下，全局服务的接口调用时，需在请求消息头中携带X-Domain-ID。
 
对于[创建API分组](https://support.huaweicloud.com/api-apig/CreateApiGroupV2.html)接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。
```
POST https://apig.cn-north-1.myhuaweicloud.com/v2/{project_id}/apigw/instances/{instance_id}/api-groups
Content-Type: application/json
X-Sdk-Date: 20240416T095341Z 
Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
```
#### 请求消息体
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码，并在Content-type中声明字符编码方式，例如：Content-Type: application/json; charset=utf-8。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于[创建API分组](https://support.huaweicloud.com/api-apig/CreateApiGroupV2.html)接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。
- **name**为API分组的名称。
- **remark**为API分组的描述。
```
POST https://apig.cn-north-1.myhuaweicloud.com/v2/{project_id}/apigw/instances/{instance_id}/api-groups
Content-Type: application/json
X-Sdk-Date: 20240416T095341Z 
Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
{
"name": "APIGroup_test",
"remark": "api group remark"
}
```
到这里为止这个请求需要的内容就具备齐全了，您可以使用[curl](https://curl.haxx.se/)、[Postman](https://www.getpostman.com/)或直接编写代码等方式发送请求调用API。
