本节介绍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不同,您可以从终端节点中获取。
例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。
resource-path 资源路径,也即API访问路径。
从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。
query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面 需要带一个“?”,形式为“参数名=参数取值”,例如
“limit=10”,表示查询不超过10条数据。
图像搜索API 参考 3 如何调用 API
例如,您需要获取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请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。REST API支持的方法如下表3-2所示。
表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”,请求鉴权信息等。
如所示需要添加公共消息头到请求中。
图像搜索API 参考 3 如何调用 API
表3-3 公共请求消息头
名称 描述 是否必选 示例
Conten
t-Type 消息体的类型(格式)。 是 applicati
on/json
证时必选 2016062 9T10145 9Z Authori
zation 签名认证信息。
该值来源于请求签名结果。
使用AK/SK认 证时必选
-Host 请求的服务器信息,从服务API的URL中获 取。值为hostname[:port]。端口缺省时使用
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
请求消息体 username
为用户名,domainname
为用户所属的账号名称,********
为用户登录密 码,xxxxxxxx
为project的name,获取方法请参见获取用户名、账号名和项目name。说明
scope参数定义了Token的作用域,上面示例中获取的Token仅能访问project下的资源。您还可 以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获 取用户Token。
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
图像搜索API 参考 3 如何调用 API
{ "auth": {
● Token认证:通过Token认证通用请求。
当调用API网关Silvan接口时,需要采用Token认证方式,需要使用“roles”为
“op_service”的token,各服务的管理账号一般都具有op_service权限。
● AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。
通过API网关向下层服务发送请求时,必须使用AK、SK对请求进行签名。