本节介绍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包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传 递它,所以在此单独强调。
表3-1 URI 中的参数说明
参数 说明
URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。
Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的 Endpoint不同,您可以从终端节点及区域获取。
resource-path 资源路径,也即API访问路径。从具体接口的URI模块获取,例如获 取用户TokenAPI的resource-path为“/v3/auth/tokens”。
query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数 前面需要带一个“?”,形式为“参数名=参数取值”,例如
“limit=10”,表示查询不超过10条数据。
例如您需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域 的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部 分找到resource-path(/v3/auth/tokens),拼接起来如下所示。
https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
图3-1 URI 示意图
说明
为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。
这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分 省略。
请求方法
HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。
表3-2 HTTP 方法
方法 说明
GET 请求服务器返回指定资源。
PUT 请求服务器更新指定资源。
POST 请求服务器新增资源或执行特殊操作。
DELETE 请求服务器删除指定资源,如删除对象等。
HEAD 请求服务器资源头部。
PATCH 请求服务器更新资源的部分内容。
当资源不存在的时候,PATCH可能会去创建一个新的资 源。
在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为:
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
请求消息头
附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请 求头“Content-Type”,请求鉴权信息等。
详细的公共请求消息头字段请参见表3-3。
表3-3 公共请求消息头
名称 描述 是否必选 示例
X-Sdk-Date 请求的发生时间,格式 为(YYYYMMDD'T'HHM MSS'Z')。
取值为当前系统的GMT 时间。
使用AK/SK认
证时必选。 20150907T101459Z
Host 请求的服务器信息,从
服务API的URL中获 取。值为hostname[:port]。端 口缺省时使用默认的端 口,https的默认端口为 443。
使用AK/SK认
证时必选。 code.test.com or
code.test.com:443
Content-Type 发送的实体的MIME类 型。推荐用户默认使用 application/json,有其 他取值时会在具体接口 中专门说明。
是 application/json
Content-Length 请求body长度,单位为
Byte。 POST/PUT请 求必填。 GET 不能包含。
3495
X-Project-Id project id,用于不同
project取token。 否 e9993fc787d94b6c886 cbaa340f9c0f4
X-Auth-Token 用户Token。
用户Token也就是调用
-X-Language 请求语言,支持配置如 下值:
● zh-cn:中文
● en-us:英文
否 en-us
X-Domain-Id 账号ID。 否
-说明
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
请求消息体(可选) username
为用户名,domainname
为用户所属的账号名称,********
为用户登录密 码,xxxxxxxxxxxxxxxxxx
为project的ID,获取方法请参见获取项目ID。说明
scope参数定义了Token的作用域,上面示例中获取的Token仅能访问project下的资源。您还可 以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见 IAM服务的获取用户Token。
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
{ "auth": {