# 业务面API构造请求
本节介绍GES业务面REST API请求的组成。
#### 请求URI
图引擎服务业务面API请求URI由如下部分组成。
**{URI-scheme} :// {SERVER_URL} / {resource-path} ? {query-string}**
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独拿出来强调。
- **URI-scheme** ：表示用于传输请求的协议，当前所有API均采用**HTTPS**协议。
- **SERVER_URL** ：图的访问地址，取值请参考[业务面API使用限制](https://support.huaweicloud.com/api-ges/ges_03_0139.html)。
- **resource-path**：资源路径，即API访问路径。从具体API的URI模块获取，例如"ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query"。
- **query-string**：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个"？"，形式为"参数名=参数取值"，例如"limit=10"，表示查询不超过10条数据。
 
#### 请求方法
HTTP请求方法（也称为操作或动词），可告知服务正在请求什么类型的操作。
- **GET**：请求服务器返回指定资源。
- **PUT**：请求服务器更新指定资源。
- **POST**：请求服务器新增资源或执行特殊操作。
- **DELETE**：请求服务器删除指定资源，如删除对象等。
- **HEAD**：请求服务器资源头部。
- **PATCH**：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。
 
#### 请求消息头
附加请求消息头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求消息头"Content-Type"，请求鉴权信息等。
如下公共消息头需要添加到请求中。
表1公共请求消息头 
| 参数名          | 是否必选 | 说明                                                                                                                                                                                               | 示例               |
|:---|:---|:---|:---|
| Content-Type | 是    | 消息体的类型（格式），默认取值为"application/json"，有其他取值时会在具体接口中专门说明。                                                                                                                                            | application/json |
| X-Auth-Token | 否    | 用户Token。例如，IAM用户Token也就是调用[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口的响应值，该接口是唯一不需要认证的接口。图版本低于24.17时必选。2.4.17及以上版本图支持通过api-key鉴权。                                    | -                |
| X-Language   | 是    | 请求语言。支持配置如下值： - zh-cn：中文  - en-us：英文   | en-us            |
| X-Api-Key    | 否    | 图关联的认证凭据。2.4.17及以上版本的图支持。                                                                                                                                                                        | -                |
   
#### 请求消息体
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
例如，对于IAM[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中***username*** 为用户名，***domainname*** 为用户所属的账号名称，***\*\*\*\*\*\*\*\**** 为用户登录密码，***xxxxxxxxxxxxxxxxxx*** 为project的名称。例如cn-north-1，可以从[地区和终端节点](https://developer.huaweicloud.com/endpoint?all)中获取。
![](https://support.huaweicloud.com/api-ges/public_sys-resources/note_3.0-zh-cn.png)
scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见IAM[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)。
```
POST https: //iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json
{
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "name": "username",
                    "password": "********",
                    "domain": {
                        "name": "domainname"
                    }
                }
            }
        },
        "scope": {
            "project": {
                "name": "xxxxxxxxxxxxxxxxxx"
            }
        }
    }
}
```
到这里为止这个请求需要的内容就具备齐全了，您可以使用[curl](https://curl.haxx.se/)、[Postman](https://www.getpostman.com/)或直接编写代码等方式发送请求调用API。对于IAM[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口，返回的响应消息头中"x-subject-token"就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。