构造请求
本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token接口来说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。
可以通过视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987 。
请求URI
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
|
参数 |
说明 |
|---|---|
|
URI-scheme |
传输请求的协议，当前所有API均采用HTTPS协议。 |
|
Endpoint |
承载REST服务端点的服务器域名或IP，不同服务在不同区域时，对应Endpoint不同，可以从终端节点中获取。 例如园区智能体服务在“华北-北京一”区域的Endpoint为“iva.cn-north-1.myhuaweicloud.com”。 |
|
resource-path |
资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 |
|
query-string |
查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 |
例如您需要获取“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iva.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。
https://iva.cn-north-1.myhuaweicloud.com/v3/auth/tokens
为查看方便，服务每个具体API的URI，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。
请求方法
HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。
|
方法 |
说明 |
|---|---|
|
GET |
请求服务器返回指定资源。 |
|
PUT |
请求服务器更新指定资源。 |
|
POST |
请求服务器新增资源或执行特殊操作。 |
|
DELETE |
请求服务器删除指定资源，如删除对象等。 |
|
HEAD |
请求服务器资源头部。 |
|
PATCH |
请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 |
POST https://iva.cn-north-1.myhuaweicloud.com/v3/auth/tokens
请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。
需要添加到请求中的公共消息头如表3所示。
|
参数名 |
说明 |
是否必选 |
示例 |
|---|---|---|---|
|
Content-type |
消息体的类型（格式），默认取值为“application/json”。 |
是 |
application/json |
|
Content-Length |
请求body长度，单位为Byte。 |
POST/PUT请求必填。GET不能包含。 |
3495 |
|
X-Project-Id |
project id，用于不同project取token。 |
否 |
e9993fc787d94b6c886cbaa340f9c0f4 |
|
X-Auth-Token |
用户Token，也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 |
否 使用Token认证时必选。 |
- |
|
X-Sdk-Date |
请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 |
否 如果使用ak/sk做接口认证的时候，那么此字段必须设置；如果使用PKI token的时候，不必设置。 |
20190307T101459Z |
|
Authorization |
签名认证信息。 该值来源于请求签名结果，使用AK/SK进行加密签名的时候需要。 类型：字符串 默认值：无 |
否 使用AK/SK认证时必选。 |
SDK-HMAC-SHA256 Credential=ZIRRKMTWPTQFQI1WKNKB/20150907//ec2/sdk_request, SignedHeaders=content-type;host;x-sdk-date, Signature=55741b610f3c9fa3ae40b5a8021ebf7ebc2a28a603fc62d25cb3bfe6608e1994 |
|
Host |
请求的服务器信息，从服务API的URL中获取。 值为hostname[:port]。 端口缺省时使用默认的端口，https的默认端口为443。 |
否 使用AK/SK认证时必选。 |
code.test.com or code.test.com:443 |
公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK认证的详细说明请参见API签名指南。
POST https://iva.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
请求消息体
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。
加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的帐号名称，********为用户登录密码，cn-north-1为project的name，获取方法请参见获取用户名、帐号名和项目name。
scope参数定义了Token的作用范围，取值为project或domain，示例中取值为project，表示获取的Token仅能访问指定project下的资源，取值为domainname时，表示获取的token可以访问指定帐号下所有资源，scope参数的详细说明，请参见获取用户Token接口。
POST https://iva.cn-north-1.myhuaweicloud.com/v3/auth/tokens
Content-Type:application/json
{
"auth": {
"identity": {
"methods": ["password"],
"password": {
"user": {
"name": "username", //替换为实际用户名
"password": "**********",//替换为实际的用户密码
"domain": {
"name": "domianname" //替换为实际帐号名
}
}
}
},
"scope": {
"project": {
"name": "cn-north-1" //替换为实际的project name，获取作用范围为指定project的Token
}
}
}
}
到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API，Postman建议使用7.24.0版本。
对于获取用户Token接口，返回的响应消息头中“x-subject-token”的值，就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
