本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口来说明如何 调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。
您还可以通过这个视频教程了解如何构造请求调用API。
请求 URI
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
表3-2 请求 URI
参数 说明
URI-scheme 传输请求的协议,当前所有API均采用HTTPS协议。
API 参考 3 如何调用 API
参数 说明
Endpoint 承载REST服务端点的服务器域名或IP,不同服务在不同区域时,对 应Endpoint不同,可以从终端节点中获取。
例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。
resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取 用户Token”API的resource-path为“/v3/auth/tokens”。
query-string 查询参数,可选,查询参数前面需要带一个“?”,形式为“参数 名=参数取值”,例如“limit=10”,表示查询不超过10条数据。
例如,您需要获取IAM在“华北-北京四””区域的Token,则需使用“华北-北京四”
区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的 URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。
https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 说明
为查看方便,服务每个具体API的URI,只给出resource-path部分,并将请求方法写在一起。这 是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省 略。
请求方法
HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。
表3-3 HTTP 方法
方法 说明
GET 请求服务器返回指定资源。
PUT 请求服务器更新指定资源。
POST 请求服务器新增资源或执行特殊操作。
DELETE 请求服务器删除指定资源,如删除对象等。
HEAD 请求服务器资源头部。
PATCH 请求服务器更新资源的部分内容。
当资源不存在的时候,PATCH可能会去创建一个新的资 源。
在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为:
POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
API 参考 3 如何调用 API
请求消息头
X-Project-Id project id,用于不同
project取token。 否 e9993fc787d94b6c886 cbaa340f9c0f4
参数名 说明 是否必选 示例
username
为用户名,domainname
为用户所属的账号名称,********
为用户登录密 码,cn-north-4
为project的name,获取方法请参见获取用户名、账号名和项目name。
说明
● scope参数定义了Token的作用范围,取值为project或domain,示例中取值为project,表示 获取的Token仅能访问指定project下的资源,取值为domainname时,表示获取的token可以 访问指定账号下所有资源,scope参数的详细说明,请参见获取用户Token。
● project name:在“我的凭证”页面,项目列表中“项目”列的值就是“project name”,
具体获取方式请参见获取用户名、账号名和项目name。
}
● AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。