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