管理面API构造请求
本章节介绍GES管理面REST API请求的组成。
请求URI
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独拿出来强调。
- URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。
- Endpoint：表示终端节点，不同服务不同区域的终端节点不同。
- resource-path：资源路径，即API访问路径。从具体API的URI模块获取，例如IAM“获取用户Token”API的resource-path为“/v3/auth/tokens”。
- query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。
请求方法
HTTP请求方法（也称为操作或动词），可告知服务正在请求什么类型的操作。
- GET：请求服务器返回指定资源。
- PUT：请求服务器更新指定资源。
- POST：请求服务器新增资源或执行特殊操作。
- DELETE：请求服务器删除指定资源，如删除对象等。
- HEAD：请求服务器资源头部。
- PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。
请求消息头
附加请求消息头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求消息头“Content-Type”，请求鉴权信息等。
如下公共消息头需要添加到请求中。
|
参数 |
是否必选 |
说明 |
示例 |
|---|---|---|---|
|
Content-Type |
是 |
消息体的类型（格式），默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 |
application/json |
|
X-Auth-Token |
使用Token方式认证时必选 |
用户Token。 |
- |
|
X-Project-ID |
否 |
子项目ID。在多项目场景中使用，用于不同项目获取token。 |
e9993fc787d94b6c886cbaa340f9c0f4 |
|
Authorization |
使用AK/SK认证时必选。 |
签名认证信息。该值来源于请求签名结果。 |
- |
|
X-Sdk-Date |
使用AK/SK认证时必选。 |
请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 |
20150907T101459Z |
|
Host |
使用AK/SK认证时必选。 |
请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 |
code.test.com or code.test.com:443 |
|
Content-Length |
POST/PUT请求必填。 GET不能包含。 |
请求body长度，单位为Byte。 |
3495 |
|
X-Language |
否 |
请求语言。 |
en-us |
API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。
请求消息体
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
例如，对于IAM获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称。
到这里为止这个请求需要的内容就具备齐全了，您可以直接编写代码等方式发送请求调用API。对于IAM获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
